Skip to content
Dixa API/
/
Query AI agent metric

Query AI agent metric

Request

Get the value of an AI agent metric for a period. All aggregates of the metric are returned. If nothing matches, the counts are 0. Deleted AI agents are included.

Security
ApiKeyAuth
Path
metricIdstringrequired

The id of an AI agent metric

Bodyapplication/jsonrequired

The query

One of:

An AI agent metric query

primaryFilterobject(AiAgentPrimaryFilter)required

The period to query

filtersArray of objects(SecondaryFilter)

The filters to apply. All filters must match

timezonestringrequired

The timezone presets and days are evaluated in, such as Europe/Copenhagen

POST
/beta/intelligence/aiagents/metrics/{metricId}
curl -i -X POST \
  'https://dev.dixa.io/beta/intelligence/aiagents/metrics/{metricId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryFilter": {
      "period": {
        "interval": {
          "from": "2026-06-01T00:00:00Z",
          "to": "2026-07-01T00:00:00Z"
        }
      }
    },
    "timezone": "Europe/Copenhagen"
  }'

Responses

The metric values, keyed by aggregate name

Bodyapplication/json
dataobjectrequired

The metric values, keyed by the name of each of the metric's aggregates. All aggregates are included. If nothing matches, count is 0, min, max, sum, average, stdDev and percentage are null, and an object value is filled with zeros

Response
The number of rated answers, and how many were rated thumbs up and thumbs down
{
  "data": {
    "count": 412,
    "thumbsUp": 351,
    "thumbsDown": 61
  }
}