Skip to content
Dixa API/
/
Get metric

Get metric

Request

Get a single metric's catalogue entry.

Security
ApiKeyAuth
Path
metricIdstringrequired

A metric id from List Metrics

GET
/beta/intelligence/metrics/{metricId}
curl -i -X GET \
  'https://dev.dixa.io/beta/intelligence/metrics/{metricId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

One metric's anchors, filters, aggregates and the records it is derived from

Bodyapplication/json
dataobject(MetricCatalogueEntry)required

One metric's catalogue entry: what a client reads to understand and query the metric, not its data

Response
{
  "data": {
    "id": "closedConversations",
    "name": "Closed conversations",
    "category": "conversations",
    "description": "The number of conversations closed in the selected period",
    "deprecated": false,
    "primaryFilters": [ … ],
    "filters": [ … ],
    "aggregates": [ … ],
    "relatedRecordIds": [ … ]
  }
}