Catalog

Dimensions, metrics and built-in report templates.

Generated

This page is generated from api/openapi/v1.yaml (OpenAPI 3.1.0, API version 1.0.0).

This OpenAPI document (no authentication)

GET/v1/openapi.json

Responses

Status	Description
200	The OpenAPI 3.1 document as JSON.

List dimensions and metrics

GET/v1/catalog

Scope: reports:read. Every identifier usable in dimensions, metrics and filters, with the scopes where it is available.

Parameters

Name	In	Type	Required	Description
scope	query	"event" | "session" | "segment" | "page" | "user" | "element"

Responses

Status	Description
200	Catalog.
400	Invalid body or query (invalid_request), with errors[] for validation failures.
401	Missing, invalid, expired or revoked API key (unauthorized).
403	The key lacks the required scope (forbidden_scope).

Response fields

Field	Type	Required	Description
scopes	array of object
dimensions	array of object
metrics	array of object

List built-in report templates

GET/v1/templates

Scope: reports:read. 30 templates mirroring GA4, Piano and Matomo, plus the agents vs humans reports.

Parameters

Name	In	Type	Required	Description
limit	query	integer
cursor	query	string		The next_cursor of the previous page.

Responses

Status	Description
200	Templates.
401	Missing, invalid, expired or revoked API key (unauthorized).
403	The key lacks the required scope (forbidden_scope).

Response fields

Field	Type	Required	Description
sections	array of object	yes
data	array of object	yes
next_cursor	string | null	yes

Get a report template with its widgets

GET/v1/templates/{id}

Scope: reports:read.

Parameters

Name	In	Type	Required	Description
id	path	string	yes	Template id (see GET /templates), e.g. humans_vs_agents.

Responses

Status	Description
200	The template.
401	Missing, invalid, expired or revoked API key (unauthorized).
404	Unknown endpoint, or a property / object that does not exist or is not accessible with this key (not_found).