Get Metadata (Domains, Entities, Columns)

GET 
/api/v2/report-builder/metadata

Returns all available domains, entities, and columns that can be used to build a report definition. Use this to populate the report builder UI with selectable fields.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The response contains the full schema of reportable data: which domains are available (e.g., inventory, sales), which entities exist within each domain, and which columns (dimensions and measures) can be selected for each entity.

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.