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

# Get the analytics catalog

`GET /analytics/catalog`

## Request

- Base URL: `https://api.commonroom.io/api/v2`
- URL: `https://api.commonroom.io/api/v2/analytics/catalog`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/analytics/catalog/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists the entities, dimensions, filters and metrics that `GET /analytics/query` accepts. Read it
before building a query: metric keys, the groupings each metric supports and filter keys come from here.
The token must grant `analytics:read` (or the encompassing `read` scope).

## Response `200`

OK

- AnalyticsCatalogResponse
  - `success` true, required
  - `data` object, required: What `GET /analytics/query` accepts. Each metric names its entity, unit and temporality and lists the `groupBy` combinations it supports. Each dimension lists the columns it adds to a row. Each filter is a query parameter that chooses who is counted. New entries and fields may be added.
    - `entities` object[], required
    - `dimensions` object[], required
    - `filters` object[], required
    - `metrics` object[], required

## Other responses

- `403`: Token is missing the `analytics:read` scope
- `429`: Rate Limited

---

[API](https://skmtc.dev/commonroom/apis/common-room-api-v2.md) - [All operations](https://skmtc.dev/commonroom/apis/common-room-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/commonroom/apis/common-room-api-v2/revisions/865d4d43dadf?raw)