---
title: "Metric Records Catalogue"
method: GET
path: "/beta/analytics/records"
tags: ["Analytics"]
---

# Metric Records Catalogue

`GET /beta/analytics/records`

This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data

## Query parameters

- `pageLimit` integer
- `pageKey` string

## Response `200`

The catalogue of metric records

- GetMetricRecordsOutput
  - `data` MetricRecordMetadata[]
    - `id` string, required — The record ID
    - `description` string, required — Relevant information about the record
    - `filters` FilterMetadata[] — List of available filters that can be used when fetching record data
      - `filterAttribute` string, required
      - `description` string
    - `relatedMetricIds` string[] — List of metric IDs that make use of this record
    - `fieldsMetadata` FieldMetadata[] — Information about the individual record fields
      - `field` string, required
      - `description` string, required
      - `nullable` boolean, required
  - `meta` PaginationLinks
    - `previous` string — url
    - `next` string — url

## Other responses

- `400` — Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey
- `500` — Internal Server Error

---

[API](https://skmtc.net/dixa/apis/dixa-api.md) · [All operations](https://skmtc.net/dixa/apis/dixa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dixa/dixa-api/versions/5eaff14a2c46/schema)