Get Report Builder Metadata
GET/api/v2/report-builder/metadata
List every domain, entity, dimension, measure and join you can use in a report definition.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Response: domains[], each with key, label and entities[]. Each entity has key, label, domain, table, description, dimensions[] (key, label, type — string, number, date, datetime or boolean — description, filterable, groupable, kind), measures[] (key, label, default aggregation, type, description, format, decimals, kind) and joins[] (target_entity, target_table, local_key, foreign_key, type, cardinality). An entity's key is what base_entity and column entity take; dimension and measure keys are what column field takes.
Authentication: Bearer token (Personal Access Token). Personal access tokens need the reports:read scope.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.