> ## Documentation Index
> Fetch the complete documentation index at: https://docs.launchpointhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# View analytics overview

> Get analytics with filtering support.

Like the /overall page in the web app, this endpoint returns:
- Summary metrics
- Top performing posts
- Top performing creators
- Platform breakdown

When `fromDate` and/or `toDate` are provided, `summary` follows the same
activity attribution model as the dashboard Performance Overview chart:
- daily deltas from post `daily` stats
- first-stat totals attributed back to the upload date
- posts without daily stats attributed to their upload date

`snapshotSummary`, `topPosts`, `topCreators`, and `platformBreakdown`
stay as upload-date snapshot views, matching the `/overall` page tables.

Agency accounts can pass `scope=agency` to calculate the overview across
the parent agency and every subaccount.




## OpenAPI

````yaml /api-reference/openapi.json get /analytics/overview
openapi: 3.0.4
info:
  title: Launchpoint Public API
  version: 1.0.0
  description: >-
    **Private preview.** The Launchpoint Public API is in private preview and
    available only to trusted partners we work with directly. Access is not
    self-serve. Email hi@launchpointhq.com to ask about access.


    REST API for Launchpoint brands and agencies. Use an API key in the
    `x-api-key` header to authenticate.


    ## Requirements

    - Public API access must be enabled for the company. During private preview,
    access is limited to trusted partners.

    - Create and manage API keys in Dashboard → Settings → Developer.


    ## Creator privacy

    - Responses never include creator email addresses. Creator phone numbers are
    null when no number is stored or the workspace does not have access to
    creator contact details.


    ## Rate limits

    - Default: **100 requests per minute** per API key.

    - Approved partner accounts: **400 requests per minute**.

    - Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and
    `X-RateLimit-Reset`. Requests over the limit return `429`.


    ## Errors

    - Errors use `{ "error": "<message>" }` with the matching HTTP status. Some
    endpoints also include a `code`.


    ## Timestamps

    - Timestamps are Unix timestamps in milliseconds unless a field says
    otherwise.


    ## Pagination

    - Most list endpoints accept `page` and `limit` and return `{ data, page,
    total }`. Some also return `totalPages`.

    - `scope=company` is the default. A parent agency key can pass
    `scope=agency` on supported routes to include its own data and linked
    brands.
servers:
  - url: https://dashboard.launchpointhq.com/api/v1
    description: Live API server
security:
  - apiKeyAuth: []
tags:
  - name: Deals
    description: Public creator opportunities across Launchpoint
  - name: Programs
    description: Programs and campaign management
  - name: Posts
    description: Posts and social content
  - name: Analytics
    description: KPIs and performance metrics
  - name: Payouts
    description: Payouts, balances, and pending creator funds
  - name: Contracts
    description: Contracts and creator agreements
  - name: Creators
    description: Creator profiles and metrics
  - name: Applications
    description: Creator applications to Canvas programs
  - name: Messages
    description: Read and send creator messages
paths:
  /analytics/overview:
    get:
      tags:
        - Analytics
      summary: View analytics overview
      description: |
        Get analytics with filtering support.

        Like the /overall page in the web app, this endpoint returns:
        - Summary metrics
        - Top performing posts
        - Top performing creators
        - Platform breakdown

        When `fromDate` and/or `toDate` are provided, `summary` follows the same
        activity attribution model as the dashboard Performance Overview chart:
        - daily deltas from post `daily` stats
        - first-stat totals attributed back to the upload date
        - posts without daily stats attributed to their upload date

        `snapshotSummary`, `topPosts`, `topCreators`, and `platformBreakdown`
        stay as upload-date snapshot views, matching the `/overall` page tables.

        Agency accounts can pass `scope=agency` to calculate the overview across
        the parent agency and every subaccount.
      parameters:
        - $ref: '#/components/parameters/ScopeParam'
        - in: query
          name: programId
          schema:
            type: string
          description: Narrow analytics to a program
        - in: query
          name: creatorId
          schema:
            type: string
          description: Narrow analytics to a creator
        - in: query
          name: platform
          schema:
            $ref: '#/components/schemas/PostPlatform'
          description: Narrow analytics to a platform
        - in: query
          name: fromDate
          schema:
            type: string
            format: date
        - in: query
          name: toDate
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Analytics overview returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          totalPosts:
                            type: integer
                          totalViews:
                            type: integer
                          totalLikes:
                            type: integer
                          totalComments:
                            type: integer
                          totalShares:
                            type: integer
                          totalBookmarks:
                            type: integer
                          totalEarnings:
                            type: number
                          cpm:
                            type: number
                            nullable: true
                            description: >-
                              Cost per 1,000 views: creator earnings divided by
                              views, times 1,000, in dollars. Null when there
                              are no views or no money paid yet.
                          engagementRate:
                            type: number
                          totalContracts:
                            type: integer
                          activeContracts:
                            type: integer
                          uniqueCreators:
                            type: integer
                      snapshotSummary:
                        type: object
                        description: >-
                          Legacy snapshot totals by upload date for the same
                          filters
                        properties:
                          totalPosts:
                            type: integer
                          totalViews:
                            type: integer
                          totalLikes:
                            type: integer
                          totalComments:
                            type: integer
                          totalShares:
                            type: integer
                          totalBookmarks:
                            type: integer
                          totalEarnings:
                            type: number
                          cpm:
                            type: number
                            nullable: true
                            description: >-
                              Cost per 1,000 views: creator earnings divided by
                              views, times 1,000, in dollars. Null when there
                              are no views or no money paid yet.
                          engagementRate:
                            type: number
                          uniqueCreators:
                            type: integer
                      topPosts:
                        type: array
                        items:
                          type: object
                        description: >-
                          Top 10 posts by snapshot views among posts uploaded in
                          the selected range
                      topCreators:
                        type: array
                        items:
                          type: object
                        description: >-
                          Top 10 creators by snapshot views among posts uploaded
                          in the selected range
                      platformBreakdown:
                        type: object
                        description: >-
                          Snapshot metrics by platform for posts uploaded in the
                          selected range
components:
  parameters:
    ScopeParam:
      in: query
      name: scope
      required: false
      schema:
        type: string
        enum:
          - company
          - agency
        default: company
      description: >-
        Choose the data scope. `company` (default) limits results to the API key
        company's data. `agency` includes the parent agency and its linked
        brands. `scope=agency` requires a parent agency key; other keys receive
        `403`.
  schemas:
    PostPlatform:
      type: string
      enum:
        - tiktok
        - instagram
        - youtube
        - facebook
        - snapchat
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created in Dashboard → Settings → Developer

````