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

# List Metrics

> Lists every metric you can query, with its unit and the properties you can filter or break it down by.



## OpenAPI

````yaml /openapi/api-v1-native.yml get /stats
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema
    at build time.
  version: v1
servers:
  - url: https://{defaultHost}
    variables:
      defaultHost:
        default: api.whop.com/api/v1
security: []
paths:
  /stats:
    parameters:
      - $ref: '#/components/parameters/ApiVersionDate'
    get:
      tags:
        - Stats
      summary: List Metrics
      description: >-
        Lists every metric you can query, with its unit and the properties you
        can filter or break it down by.
      operationId: listMetrics
      responses:
        '200':
          description: metric catalog
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: The available metrics.
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          description: >-
                            The metric's key. Pass it to GET /stats/{metric} to
                            query its values.
                        name:
                          type: string
                          description: Human-readable display name for the metric.
                        unit:
                          type: string
                          enum:
                            - count
                            - currency
                            - percent
                          description: >-
                            How to read the metric's values: count is an
                            integer, currency is a decimal amount, and percent
                            is a number where 1.6 means 1.6%.
                        properties:
                          type: array
                          items:
                            type: string
                          description: >-
                            The properties you can use with this metric — pass
                            one as a filter (property=value) to narrow the
                            series, or as breakdown_by=property to split it.
                        description:
                          type: string
                          description: A short description of what the metric measures.
                        windows:
                          type: array
                          items:
                            type: string
                          description: >-
                            Snapshot metrics only: the trailing windows you can
                            pass as snapshot_window, for example 30d. Absent on
                            live metrics, which use from/to instead.
                      required:
                        - key
                        - name
                        - unit
                        - properties
                        - description
                required:
                  - data
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: missing or invalid authentication
      security:
        - bearerAuth: []
components:
  parameters:
    ApiVersionDate:
      name: Api-Version-Date
      in: header
      required: false
      schema:
        type: string
        format: date
        example: '2026-06-20'
      description: >-
        Pins the request to a dated API version. When omitted, the request uses
        the original (2025-01-01) request/response shapes, so existing
        unversioned callers are never broken. Generated SDKs always send the
        latest version they were built against. An unrecognized value is
        rejected with a 400. The schemas documented here always describe the
        latest version.
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
  schemas:
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - type
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: auth-scheme
      description: >-
        An account API key, account scoped JWT, app API key, or user OAuth
        token.

````