Skip to content
Dixa API/
/
Metrics Catalogue

Dixa API (v1)

Download OpenAPI description
v1.json
v1.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/v1
https://dev.dixa.io

Analytics

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/v1/v1/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/v1/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
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/v1/v1/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/v1/v1/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/v1/v1/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": [
    { … },
    { … }
  ]
}

Get Metric Records Data

Request

Get data of specific metric records (unaggregated)

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.

Bodyapplication/jsonrequired

The available request filters for fetching the metric records data

One of:
idstringrequired
csidFilterArray of integers(int64)non-empty
filtersArray of objects(Filter)
timezonestringrequired
curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/analytics/records?pageLimit=0&pageKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "closed_conversations",
    "periodFilter": {
      "value": {
        "_type": "PreviousWeek"
      },
      "_type": "Preset"
    },
    "filters": [
      {
        "attribute": "initial_direction",
        "values": [
          "INBOUND"
        ]
      }
    ],
    "timezone": "Europe/Copenhagen"
  }'

Responses

The metric records data

Bodyapplication/json
dataArray of objects(MetricRecord)
metaobject(PaginationLinks)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Metric Record Description

Request

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

Security
ApiKeyAuth
Path
recordIdstringrequired
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/analytics/records/{recordId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The metric record properties

Bodyapplication/json
dataobject(MetricRecordMetadata)required
data.​idstringrequired

The record ID

data.​descriptionstringrequired

Relevant information about the record

data.​filtersArray of objects(FilterMetadata)

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

data.​relatedMetricIdsArray of strings

List of metric IDs that make use of this record

data.​fieldsMetadataArray of objects(FieldMetadata)

Information about the individual record fields

Response
application/json
{
  "data": {
    "id": "ratings",
    "description": "Conversation Ratings",
    "filters": [ … ],
    "relatedMetricIds": [ … ],
    "fieldsMetadata": [ … ]
  }
}

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations