Sign in

v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/metric

GET /api/metric/{id}

Fetch a Metric with ID.

Returns the metric with hydrated dimensions and dimension mappings.

get/api/metric/{id}

Path parameters

idinteger required

value must be an integer greater than zero.

Response

Successful response

collection_idinteger nullable required

value must be an integer greater than zero.

database_idinteger nullable

value must be an integer greater than zero.

dataset_queryobject
descriptionstring nullable required
dimension_mappingsobject[] nullable
dimensionsobject[] nullable
idinteger required

value must be an integer greater than zero.

namestring required
result_column_namestring nullable