Klaviyo

Klaviyo Metrics API

metrics

GitHub OpenAPI

Operations 24

GET /api/metrics Get Metrics #
GET /api/metrics/{id} Get Metric #
GET /api/metric-properties/{id} Get Metric Property #
GET /api/custom-metrics Get Custom Metrics #
POST /api/custom-metrics Create Custom Metric #
GET /api/custom-metrics/{id} Get Custom Metric #
PATCH /api/custom-metrics/{id} Update Custom Metric #
DELETE /api/custom-metrics/{id} Delete Custom Metric #
GET /api/mapped-metrics Get Mapped Metrics #
GET /api/mapped-metrics/{id} Get Mapped Metric #
PATCH /api/mapped-metrics/{id} Update Mapped Metric #
POST /api/metric-aggregates Query Metric Aggregates #
GET /api/metrics/{id}/flow-triggers Get Flows Triggered by Metric #
GET /api/metrics/{id}/relationships/flow-triggers Get IDs for Flows Triggered by Metric #
GET /api/metrics/{id}/metric-properties Get Properties for Metric #
GET /api/metrics/{id}/relationships/metric-properties Get Property IDs for Metric #
GET /api/metric-properties/{id}/metric Get Metric for Metric Property #
GET /api/metric-properties/{id}/relationships/metric Get Metric ID for Metric Property #
GET /api/custom-metrics/{id}/metrics Get Metrics for Custom Metric #
GET /api/custom-metrics/{id}/relationships/metrics Get Metric IDs for Custom Metric #
GET /api/mapped-metrics/{id}/metric Get Metric for Mapped Metric #
GET /api/mapped-metrics/{id}/relationships/metric Get Metric ID for Mapped Metric #
GET /api/mapped-metrics/{id}/custom-metric Get Custom Metric for Mapped Metric #
GET /api/mapped-metrics/{id}/relationships/custom-metric Get Custom Metric ID for Mapped Metric #

Documentation

📖
Documentation
https://developers.klaviyo.com/
📖
Authentication
https://developers.klaviyo.com/en/docs/authenticate_
📖
RateLimits
https://developers.klaviyo.com/en/docs/rate_limits_and_error_handling

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/klaviyo/refs/heads/main/openapi/klaviyo-metrics-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/klaviyo/refs/heads/main/asyncapi/klaviyo-webhooks-asyncapi.yaml

Other Resources

🔗
Reference
https://developers.klaviyo.com/en/reference/api_overview
🔗
Versioning
https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy
🔗
ChangeLog
https://developers.klaviyo.com/en/docs/changelog_
🔗
SDKs
https://developers.klaviyo.com/en/docs/sdk_overview
🔗
GitHub
https://github.com/klaviyo/openapi
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/klaviyo/refs/heads/main/overlays/klaviyo-metrics-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/klaviyo-metrics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

klaviyo-metrics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Klaviyo Accounts Metrics API
  version: '2026-04-15'
  description: The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
  contact:
    name: Klaviyo Developer Experience Team
    email: developers@klaviyo.com
    url: https://developers.klaviyo.com
  termsOfService: https://www.klaviyo.com/legal/api-terms
  license:
    name: License
    url: https://www.klaviyo.com/legal
servers:
- url: https://a.klaviyo.com
  description: Production
security:
- Klaviyo-API-Key: []
tags:
- name: Metrics
  description: metrics
paths:
  /api/metrics:
    get:
      operationId: get_metrics
      summary: Get Metrics
      description: 'Get all metrics in an account.


        Requests can be filtered by the following fields:

        integration `name`, integration `category`


        Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: fields[flow]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - archived
            - created
            - name
            - status
            - trigger_type
            - updated
        explode: false
      - name: fields[metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - integration
            - name
            - updated
        explode: false
      - name: filter
        in: query
        description: 'For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`'
        schema:
          type: string
          example: equals(integration.name,'example')
      - name: include
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships
        schema:
          type: array
          items:
            type: string
            enum:
            - flow-triggers
        explode: false
      - name: page[cursor]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination
        required: false
        schema:
          type: string
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetMetricResponseCollectionCompoundDocument'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 10/s
        steady: 150/m
      x-klaviyo-scopes:
      - metrics:read
  /api/metrics/{id}:
    get:
      operationId: get_metric
      summary: Get Metric
      description: 'Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: id
        in: path
        description: Metric ID
        required: true
        schema:
          description: Metric ID
          type: string
      - name: fields[flow]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - archived
            - created
            - name
            - status
            - trigger_type
            - updated
        explode: false
      - name: fields[metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - integration
            - name
            - updated
        explode: false
      - name: include
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships
        schema:
          type: array
          items:
            type: string
            enum:
            - flow-triggers
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetMetricResponseCompoundDocument'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 10/s
        steady: 150/m
      x-klaviyo-scopes:
      - metrics:read
  /api/metric-properties/{id}:
    get:
      operationId: get_metric_property
      summary: Get Metric Property
      description: 'Get a metric property with the given metric property ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: id
        in: path
        description: The ID of the metric property
        required: true
        schema:
          description: The ID of the metric property
          type: string
          example: 925e385b52fb405715f3616c337cc65c
      - name: additional-fields[metric-property]
        in: query
        description: 'Request additional fields not included by default in the response. Supported values: ''sample_values'''
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sample_values
        explode: false
      - name: fields[metric-property]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - inferred_type
            - label
            - property
            - sample_values
        explode: false
      - name: fields[metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - integration
            - name
            - updated
        explode: false
      - name: include
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships
        schema:
          type: array
          items:
            type: string
            enum:
            - metric
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetMetricPropertyResponseCompoundDocument'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 1/s
        steady: 15/m
      x-klaviyo-scopes:
      - metrics:read
  /api/custom-metrics:
    get:
      operationId: get_custom_metrics
      summary: Get Custom Metrics
      description: 'Get all custom metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: fields[custom-metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - definition
            - definition.aggregation_method
            - definition.metric_groups
            - name
            - updated
        explode: false
      - name: fields[metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - integration
            - name
            - updated
        explode: false
      - name: include
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships
        schema:
          type: array
          items:
            type: string
            enum:
            - metrics
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetCustomMetricResponseCollectionCompoundDocument'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 3/s
        steady: 60/m
      x-klaviyo-scopes:
      - metrics:read
      x-klaviyo-subtag: Custom Metrics
    post:
      operationId: create_custom_metric
      summary: Create Custom Metric
      description: 'Create a new custom metric.


        Custom metric objects must include a `name` and `definition`.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d`


        **Scopes:**

        `metrics:write`'
      parameters:
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      requestBody:
        description: Create a custom metric.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CustomMetricCreateQuery'
      responses:
        '201':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PostCustomMetricResponse'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 1/s
        steady: 15/m
        daily: 15/d
      x-klaviyo-scopes:
      - metrics:write
      x-klaviyo-subtag: Custom Metrics
  /api/custom-metrics/{id}:
    get:
      operationId: get_custom_metric
      summary: Get Custom Metric
      description: 'Get a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: id
        in: path
        description: The ID of the custom metric
        required: true
        schema:
          description: The ID of the custom metric
          type: string
          example: 925e385b52fb405715f3616c337cc65c
      - name: fields[custom-metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - definition
            - definition.aggregation_method
            - definition.metric_groups
            - name
            - updated
        explode: false
      - name: fields[metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - integration
            - name
            - updated
        explode: false
      - name: include
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships
        schema:
          type: array
          items:
            type: string
            enum:
            - metrics
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetCustomMetricResponseCompoundDocument'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 3/s
        steady: 60/m
      x-klaviyo-scopes:
      - metrics:read
      x-klaviyo-subtag: Custom Metrics
    patch:
      operationId: update_custom_metric
      summary: Update Custom Metric
      description: 'Update a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d`


        **Scopes:**

        `metrics:write`'
      parameters:
      - name: id
        in: path
        description: The ID of the custom metric
        required: true
        schema:
          description: The ID of the custom metric
          type: string
          example: 925e385b52fb405715f3616c337cc65c
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      requestBody:
        description: Update a custom metric by ID.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CustomMetricPartialUpdateQuery'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PatchCustomMetricResponse'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 1/s
        steady: 15/m
        daily: 15/d
      x-klaviyo-scopes:
      - metrics:write
      x-klaviyo-subtag: Custom Metrics
    delete:
      operationId: delete_custom_metric
      summary: Delete Custom Metric
      description: 'Delete a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`


        **Scopes:**

        `metrics:write`'
      parameters:
      - name: id
        in: path
        description: The ID of the custom metric
        required: true
        schema:
          description: The ID of the custom metric
          type: string
          example: 925e385b52fb405715f3616c337cc65c
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 3/s
        steady: 60/m
      x-klaviyo-scopes:
      - metrics:write
      x-klaviyo-subtag: Custom Metrics
  /api/mapped-metrics:
    get:
      operationId: get_mapped_metrics
      summary: Get Mapped Metrics
      description: 'Get all mapped metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: fields[custom-metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - definition
            - definition.aggregation_method
            - definition.metric_groups
            - name
            - updated
        explode: false
      - name: fields[mapped-metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - updated
        explode: false
      - name: fields[metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - integration
            - name
            - updated
        explode: false
      - name: include
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships
        schema:
          type: array
          items:
            type: string
            enum:
            - custom-metric
            - metric
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetMappedMetricResponseCollectionCompoundDocument'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 3/s
        steady: 60/m
      x-klaviyo-scopes:
      - metrics:read
      x-klaviyo-subtag: Mapped Metrics
  /api/mapped-metrics/{id}:
    get:
      operationId: get_mapped_metric
      summary: Get Mapped Metric
      description: 'Get the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: id
        in: path
        description: The type of mapping.
        required: true
        schema:
          description: The type of mapping.
          type: string
          example: revenue
          enum:
          - added_to_cart
          - cancelled_sales
          - ordered_product
          - refunded_sales
          - revenue
          - started_checkout
          - viewed_product
      - name: fields[custom-metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - definition
            - definition.aggregation_method
            - definition.metric_groups
            - name
            - updated
        explode: false
      - name: fields[mapped-metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - updated
        explode: false
      - name: fields[metric]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - integration
            - name
            - updated
        explode: false
      - name: include
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships
        schema:
          type: array
          items:
            type: string
            enum:
            - custom-metric
            - metric
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetMappedMetricResponseCompoundDocument'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 3/s
        steady: 60/m
      x-klaviyo-scopes:
      - metrics:read
      x-klaviyo-subtag: Mapped Metrics
    patch:
      operationId: update_mapped_metric
      summary: Update Mapped Metric
      description: 'Update the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `30/d`


        **Scopes:**

        `metrics:write`'
      parameters:
      - name: id
        in: path
        description: The type of mapping.
        required: true
        schema:
          description: The type of mapping.
          type: string
          example: revenue
          enum:
          - added_to_cart
          - cancelled_sales
          - ordered_product
          - refunded_sales
          - revenue
          - started_checkout
          - viewed_product
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      requestBody:
        description: Update a mapped metric by ID
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/MappedMetricPartialUpdateQuery'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PatchMappedMetricResponse'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 1/s
        steady: 15/m
        daily: 30/d
      x-klaviyo-scopes:
      - metrics:write
      x-klaviyo-subtag: Mapped Metrics
  /api/metric-aggregates:
    post:
      operationId: query_metric_aggregates
      summary: Query Metric Aggregates
      description: 'Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request.


        To request campaign and flow performance data that matches the data shown in Klaviyo''s UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview).


        Results can be filtered and grouped by time, event, or profile dimensions.


        To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint).


        For a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      requestBody:
        description: Retrieve Metric Aggregations
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/MetricAggregateQuery'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PostMetricAggregateResponse'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-operation-aliases:
      - create_metric_aggregate
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 3/s
        steady: 60/m
      x-klaviyo-scopes:
      - metrics:read
  /api/metrics/{id}/flow-triggers:
    get:
      operationId: get_flows_triggered_by_metric
      summary: Get Flows Triggered by Metric
      description: 'Get all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`


        **Scopes:**

        `flows:read`

        `metrics:read`'
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: fields[flow]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - archived
            - created
            - name
            - status
            - trigger_type
            - updated
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetFlowResponseCollection'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-operation-aliases:
      - get_flow_triggers_for_metric
      - get_metric_flow_triggers
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 10/s
        steady: 150/m
      x-klaviyo-scopes:
      - flows:read
      - metrics:read
  /api/metrics/{id}/relationships/flow-triggers:
    get:
      operationId: get_ids_for_flows_triggered_by_metric
      summary: Get IDs for Flows Triggered by Metric
      description: 'Get the IDs of all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`


        **Scopes:**

        `flows:read`

        `metrics:read`'
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetMetricFlowTriggersRelationshipsResponseCollection'
        4XX:
          $ref: '#/components/responses/ClientError'
        5XX:
          $ref: '#/components/responses/ServerError'
      tags:
      - Metrics
      x-klaviyo-operation-aliases:
      - get_flow_trigger_ids_for_metric
      - get_metric_relationships_flow_triggers
      x-klaviyo-pre-release: None
      x-klaviyo-ratelimit:
        burst: 10/s
        steady: 150/m
      x-klaviyo-scopes:
      - flows:read
      - metrics:read
  /api/metrics/{id}/metric-properties:
    get:
      operationId: get_properties_for_metric
      summary: Get Properties for Metric
      description: 'Get the metric properties for the given metric ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`


        **Scopes:**

        `metrics:read`'
      parameters:
      - name: id
        in: path
        description: The ID of the metric
        required: true
        schema:
          description: The ID of the metric
          type: string
          example: 925e38
      - name: additional-fields[metric-property]
        in: query
        description: 'Request additional fields not included by default in the response. Supported values: ''sample_values'''
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sample_values
        explode: false
      - name: fields[metric-property]
        in: query
        description: For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - inferred_type
            - label
            - property
            - sample_values
        explode: false
      - name: revision
        in: header
        description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
        required: true
        schema:
          type: string
          default: '2026-04-15'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
             

# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/klaviyo/refs/heads/main/openapi/klaviyo-metrics-api-openapi.yml