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

# List available measures

> Return the catalog of measures available to your pixel — the same list the
in-app query builder shows. Use this to discover canonical measure ids
before constructing a query or building a dashboard.

**Required scope:** `analytics:read`.




## OpenAPI

````yaml /api-reference/openapi.yaml get /db-mgmt/api/measures
openapi: 3.1.0
info:
  title: Upstack Data API
  version: '1.0'
  description: >
    Programmatic access to your Upstack Data pixel — analytics queries, the

    measures/dimensions catalog, and dashboard view management.


    All requests authenticate with two headers:


    - `x-api-key`: your Upstack API key (mint one at **Settings → API Keys** in
    the dashboard).

    - `x-pixel-id`: the pixel id the request targets. One key is scoped to one
    pixel.
servers:
  - url: https://api.upstackdata.com
    description: Production
security:
  - apiKey: []
    pixelId: []
tags:
  - name: Analytics
    description: Query events, attribution, and cohort analyses.
  - name: Catalog
    description: List the measures available to your pixel.
  - name: Dashboards
    description: >-
      Manage dashboard views — create, update, copy, delete, and the high-level
      preset builder.
  - name: Account
    description: >-
      Read and update the account that owns this API key — display name, active
      owners and admins, and subscription summary.
  - name: Costs
    description: >-
      Read and update every cost surface — global product overrides, shipping
      method, per-variant handling fees and COGS history, and per-type cost
      lines (order / gateway / shipping profile / variable / fixed). Mutations
      trigger the same per-order COGS recalculation as web-UI changes.
  - name: Products
    description: Browse products + variants in the configured catalog.
  - name: Events
    description: Send server-side tracking events directly from your backend.
paths:
  /db-mgmt/api/measures:
    get:
      tags:
        - Catalog
      summary: List available measures
      description: >
        Return the catalog of measures available to your pixel — the same list
        the

        in-app query builder shows. Use this to discover canonical measure ids

        before constructing a query or building a dashboard.


        **Required scope:** `analytics:read`.
      operationId: listMeasures
      responses:
        '200':
          description: Measures catalog.
          content:
            application/json:
              schema:
                type: object
                required:
                  - measures
                properties:
                  measures:
                    type: array
                    items:
                      $ref: '#/components/schemas/Measure'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - apiKey: []
          pixelId: []
components:
  schemas:
    Measure:
      type: object
      required:
        - key
        - title
        - shortTitle
        - description
        - category
        - valueType
      properties:
        key:
          type: string
          example: core.new_customer_roas
        title:
          type: string
          example: New Customer ROAS
        shortTitle:
          type: string
          example: NC ROAS
        description:
          type: string
        formula:
          type: string
        category:
          type: string
          example: Core
        subcategory:
          type: string
        valueType:
          type: string
          enum:
            - count
            - currency
            - percent
            - ratio
            - duration
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          description: Per-field validation errors (present on 400 responses).
          items:
            type: object
            properties:
              message:
                type: string
              key:
                type: string
              path:
                type: array
                items:
                  type: string
  responses:
    Unauthorized:
      description: >-
        Missing or invalid `x-api-key` / `x-pixel-id`, or key is
        revoked/expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        API key does not carry the required scope for this endpoint, or body
        `pixelId` does not match the `x-pixel-id` header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Upstack API key. Starts with `upstack_`.
    pixelId:
      type: apiKey
      in: header
      name: x-pixel-id
      description: The pixel id the request targets.

````