> ## 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 key KPIs

> Get key performance indicators grouped by status.

The response includes:
- Programs (by status: active, draft, paused, etc.)
- Contracts (by status: active, pending, completed, etc.)
- Posts (total, views, engagement, paid/unpaid)
- Creators (total, with active contracts)

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




## OpenAPI

````yaml /api-reference/openapi.json get /analytics/kpis
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/kpis:
    get:
      tags:
        - Analytics
      summary: View key KPIs
      description: |
        Get key performance indicators grouped by status.

        The response includes:
        - Programs (by status: active, draft, paused, etc.)
        - Contracts (by status: active, pending, completed, etc.)
        - Posts (total, views, engagement, paid/unpaid)
        - Creators (total, with active contracts)

        Agency accounts can pass `scope=agency` to calculate KPIs across the
        parent agency and every subaccount.
      parameters:
        - $ref: '#/components/parameters/ScopeParam'
      responses:
        '200':
          description: KPIs returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      programs:
                        type: object
                        properties:
                          total:
                            type: integer
                          active:
                            type: integer
                          draft:
                            type: integer
                          paused:
                            type: integer
                          completed:
                            type: integer
                          archived:
                            type: integer
                      contracts:
                        type: object
                        properties:
                          total:
                            type: integer
                          active:
                            type: integer
                          pending:
                            type: integer
                          completed:
                            type: integer
                          declined:
                            type: integer
                          cancelled:
                            type: integer
                          expired:
                            type: integer
                      posts:
                        type: object
                        properties:
                          total:
                            type: integer
                          totalViews:
                            type: integer
                          totalLikes:
                            type: integer
                          totalComments:
                            type: integer
                          totalShares:
                            type: integer
                          paid:
                            type: integer
                          unpaid:
                            type: integer
                      creators:
                        type: object
                        properties:
                          total:
                            type: integer
                          withActiveContracts:
                            type: integer
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`.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created in Dashboard → Settings → Developer

````