Skip to content
Dixa API/
/
List metrics

List metrics

Request

List the metrics available to query, including the filters, aggregates and anchors each one accepts, and the records it is derived from. Use a metric's id with Query Conversation Metric or Query Agent Metric.

Security
ApiKeyAuth
Query
categorystring

Return only the metrics anchored to this entity. All metrics are returned when omitted.

Enum:"conversations""agents"
pageKeystring

Opaque cursor taken from a previous response's meta.next or meta.previous. Echo it back unchanged; its contents may change without notice.

pageLimitinteger, (int32)

Maximum number of entries per page. Defaults to 50, or to the size carried by pageKey when one is supplied. An over-limit value is rejected, not clamped.

Default:50
GET
/beta/intelligence/metrics
curl -i -X GET \
  'https://dev.dixa.io/beta/intelligence/metrics?category=conversations&pageKey=string&pageLimit=50' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

One page of the metrics that can be queried, in catalogue order

Bodyapplication/json
dataArray of objects(MetricCatalogueEntry)
metaobject(PaginationLinks)
Response
Abridged to two entries; the live response lists every metric, in catalogue order
{
  "data": [
    { … },
    { … }
  ]
}