Get Metric Records Data

Analytics
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Metrics Catalogue

Request

This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data

Security

ApiKeyAuth

Query

pageLimitinteger(int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/analytics/metrics?pageLimit=0&pageKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The catalogue of metrics

Bodyapplication/json

dataArray of objects(MetricMetadata)

metaobject(PaginationLinks)

Response

application/json

{
  "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

curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/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

data.idstringrequired

data.aggregatesArray of AgentPresenceDurationValue (object) or DoubleAggregateValue (object) or LongAggregateValue (object)(AggregateValue)

Response

application/json

{
  "data": {
    "id": "closed_conversations",
    "aggregates": [ … ]
  }
}

Metric Description

Request

This endpoint lists all available properties of a metric to use for querying its data

Security

ApiKeyAuth

Path

metricIdstringrequired

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/analytics/metrics/{metricId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The metric properties

Bodyapplication/json

dataobject(MetricMetadata)required

data.idstringrequired

The metric ID

data.descriptionstring

Relevant information about the metric

data.filtersArray of objects(FilterMetadata)

List of available filters that can be used when fetching metric data

data.aggregationsArray of objects(AggregateMetadata)

List of available aggregations that can be used when fetching metric data

data.relatedRecordIdsArray of strings

List of record IDs used to compose the metric

Response

application/json

{
  "data": {
    "id": "csat",
    "description": "(Number of satisfied customers (4 and 5)/ Number of survey responses) x 100 = % of satisfied customers",
    "filters": [ … ],
    "aggregations": [ … ],
    "relatedRecordIds": [ … ]
  }
}

Filter values

Request

Get possible values to be used with a given filter attribute. Filter attributes are not metric or record specific, so one filter attribute can be used with multiple metrics/records. When a filter value is not relevant for a specific metric/record, it is simply ignored.

Security

ApiKeyAuth

Path

filterAttributestringrequired

Query

pageLimitinteger(int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/analytics/filter/{filterAttribute}?pageLimit=0&pageKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The possible filter values to be used when fetching metrics or records

Bodyapplication/json

dataArray of objects(FilterValue)

metaobject(PaginationLinks)

Response

application/json

{
  "data": [
    { … },
    { … }
  ]
}

Metric Records Catalogue

Request

This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data

Security

ApiKeyAuth

Query

pageLimitinteger(int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/analytics/records?pageLimit=0&pageKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The catalogue of metric records

Bodyapplication/json

dataArray of objects(MetricRecordMetadata)

metaobject(PaginationLinks)

Response

application/json

{
  "data": [
    { … },
    { … }
  ]
}