---
title: "Get the analytics schema"
method: GET
path: "/v1/analytics/schema"
tags: ["Analytics"]
---

# Get the analytics schema

`GET /v1/analytics/schema`

## Request

- Base URL: `https://api.roark.ai`
- URL: `https://api.roark.ai/v1/analytics/schema`
- Auth: HTTP bearer

Lists what can go into an analytics query for this project: every metric by slug with its output
type, default aggregation and the aggregations it supports; the measure types; the filter and
breakdown types with the properties each accepts; and the custom call properties seen in the project.
Read this first when building a query.

## Response `200`

The analytics schema

- object
  - `data` AnalyticsSchema, required: What can be queried in this project: metrics (by slug), measure types, filters, breakdowns.
    - `metrics` object[], required
      - `id` string, uuid, required
      - `slug` string, required
      - `name` string, required
      - `outputType` string, required
      - `isThreshold` boolean, required
      - `defaultAggregation` 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE', required
      - `aggregations` string[], required
    - `measureTypes` object[], required
      - `type` 'METRIC' | 'CONVERSATION' | 'UPTIME', required
      - `description` string, required
      - `aggregations` string[], required
    - `filters` object[], required
      - `type` 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'CALL_ID' | 'MODALITY' | 'DATASET' | 'METRIC_VALUE', required
      - `description` string, required
      - `properties` object[], required
        - `property` string, required
        - `description` string, required
    - `breakdowns` object[], required
      - `type` 'METRIC_PROPERTY' | 'CALL_PROPERTY' | 'AGENT_PROPERTY' | 'DATASET', required
      - `description` string, required
    - `callProperties` object[], required
      - `name` string, required
      - `valueType` string, required
      - `isSystem` boolean, required
    - `operators` string[], required
    - `intervals` string[], required
    - `displayTypes` string[], required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

> 187 revisions in range; 1 not diffed.

- **2026-10-21** `8913d3b08c7b`: 2 warning
  - added the new `IS_NOT_SET` enum value to the `data/operators/items/` response property for the response status `200`
  - added the new `IS_SET` enum value to the `data/operators/items/` response property for the response status `200`
- **2026-10-21** `2e403107d6ec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/roarkhq/apis/roark-analytics-api/changes/v1/analytics/schema/get.md)

---

[API](https://skmtc.dev/roarkhq/apis/roark-analytics-api.md) - [All operations](https://skmtc.dev/roarkhq/apis/roark-analytics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/roarkhq/apis/roark-analytics-api/revisions/1a91a5c90e44?raw)