Skip to content
Dixa API/
/
Get Metric Data

Get Metric Data

Request

Get data of a specific metric (aggregated)

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The available request filters and aggregations for fetching the metric data

One of:
idstringrequired
csidFilterArray of integers, (int64), non-empty
filtersArray of objects(Filter)
aggregationsArray of strings
timezonestringrequired
POST
/v1/analytics/metrics
curl -i -X POST \
  https://dev.dixa.io/v1/analytics/metrics \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "closed_conversations",
    "periodFilter": {
      "value": {
        "_type": "PreviousWeek"
      },
      "_type": "Preset"
    },
    "filters": [
      {
        "attribute": "channel",
        "values": [
          "email"
        ]
      }
    ],
    "aggregations": [
      "Count"
    ],
    "timezone": "Europe/Copenhagen"
  }'

Responses

The metric data

Bodyapplication/json
dataobject(MetricData)required
Response
{
  "data": {
    "id": "closed_conversations",
    "aggregates": [ … ]
  }
}