analytics_catalog_get
Read the analytics semantic catalog: every entity this product may chart, with its declared metrics, dimensions and person-graph identity kinds.
Read the analytics semantic catalog: every entity this product may chart, with its declared metrics, dimensions and person-graph identity kinds. Call this FIRST to discover the exact `entity`, `metric` and `dimension` names analytics_metric_query and analytics_funnel_run accept — those names are resolved against this catalog and a name that is not in it is rejected. A metric `unit` describes raw money scale and its currency dimension; a dimension label link names the related entity and columns used for readable group labels. `dropped_metrics`, when present, lists metrics left out of `entities` that cannot be queried: `reason` is type_unknown (a metric type this analytics build does not support yet), aggregate_unknown (a ratio part with an unsupported aggregate) or column_missing (a count_distinct without a column).
Behavior
- HTTP
GET /analytics/catalog
Arguments
No arguments.
Response
Field | Type | Always | Description |
|---|---|---|---|
cycle | object | • | |
entities | array | • | |
product_id | string | • | |
generated_at | string | • | |
dropped_metrics | array | — |
Try it
Read the analytics semantic catalog: every entity this product may chart, with its declared metrics, dimensions and person-graph identity kinds.