---
title: "Get the analytics catalog"
method: GET
path: "/api/v1/analytics/catalog"
---

# Get the analytics catalog

`GET /api/v1/analytics/catalog`

Returns the versioned catalog of models, metrics, and dimensions accepted by the query endpoint. Use it to discover valid member names before building a query.

## Headers

- `x-request-id` string

## Response `200`

The published catalog.

- CatalogResponse
  - `catalogVersion` string, required — Version of the published member set.
  - `models` CatalogModel[], required
    - `name` string, required — Model name sent as `model` in query requests.
    - `description` string, required — Authoritative description of what the model counts.
    - `grain` string, required — What one row of the model represents.
    - `eventClock` string, required — Timestamp used to bucket rows into date ranges.
    - `metrics` CatalogMetric[], required
      - `name` string, required — Metric name for the `metrics` array in query requests.
      - `type` 'number', required
      - `description` string, required
      - `additive` boolean, required — Whether values can be summed across groups.
      - `deprecated` DeprecatedInfo, nullable, required — Deprecation metadata for a metric or dimension when set, otherwise `null`. Deprecated members remain queryable and do not automatically add a warning.
        - `since` string, required — Catalog version since which the member was deprecated.
        - `note` string, required — Guidance on what to use instead.
    - `dimensions` CatalogDimension[], required
      - `name` string, required — Dimension name for the `dimensions` and `filters` arrays.
      - `type` 'string' | 'date', required
      - `description` string, required
      - `companions` CatalogCompanion[], required — Fields returned automatically when this dimension is selected.
        - `name` string, required
        - `type` 'string', required
        - `description` string, required
      - `deprecated` DeprecatedInfo, nullable, required — Deprecation metadata for a metric or dimension when set, otherwise `null`. Deprecated members remain queryable and do not automatically add a warning.
        - `since` string, required — Catalog version since which the member was deprecated.
        - `note` string, required — Guidance on what to use instead.

## Other responses

- `401` — A missing or malformed key returns this response without spending an admission limit. A well-formed unknown or revoked key normally returns the same response, but can return 429 while the global credential-verification budget is exhausted.
- `403` — The key is valid but does not include `analytics:read`.
- `429` — A per-key rate limit, the global unknown-credential verification budget, or an analytics concurrency limit was exceeded. Read `Retry-After`.
- `500` — An unexpected application or infrastructure failure occurred.

---

[API](https://skmtc.dev/burthq/apis/burt-analytics-api.md) · [All operations](https://skmtc.dev/burthq/apis/burt-analytics-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/burthq/burt-analytics-api/revisions/fcb6a24b0e42/schema)