Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Statistics

Retrieve a statistic

post/api/stats/{name}

Path parameters

name'overview' | 'total-tickets-created' | 'total-tickets-replied' | 'total-tickets-closed' | 'total-messages-sent' | 'total-messages-received' | 'median-first-response-time' | 'median-resolution-time' | 'total-one-touch-tickets' | 'support-volume' | 'resolution-time' | 'first-response-time' | 'tickets-created-per-hour-per-weekday' | 'tickets-per-tag' | 'tickets-created-per-channel' | 'tickets-created-per-channel-per-day' | 'tickets-closed-per-agent' | 'tickets-closed-per-agent-per-day' | 'messages-sent-per-macro' | 'satisfaction-surveys' | 'latest-satisfaction-surveys' | 'intents-occurrence' | 'intents-overview' | 'intents-breakdown-per-day' | 'revenue-overview' | 'revenue-per-agent' | 'revenue-per-day' | 'revenue-per-ticket' | 'self-service-volume-per-flow' | 'self-service-article-recommendation-performance' | 'self-service-top-reported-issues' | 'self-service-products-with-most-issues-and-return-requests' | 'self-service-workflows-performance' required
Example:overview

The name of the statistic to retrieve.

Request body

Example request

{
  "filters": {
    "period": {
      "start_datetime": "2020-06-10T00:00:00-05:00",
      "end_datetime": "2020-06-16T23:59:59-05:00"
    },
    "agents": [
      12345,
      67890
    ],
    "channels": [
      "chat",
      "email"
    ],
    "campaigns": [
      "123",
      "234"
    ],
    "tags": [
      321,
      654,
      987
    ],
    "integrations": [
      555,
      777
    ],
    "score": [
      3,
      4
    ]
  }
}

Response

The requested statistic

dataobject

The data of the statistic. Data structure varies according to the type of the statistic (e.g. key metric, bar chart, table)

Example response

{
  "data": {
    "data": {
      "axes": {
        "x": [
          1591765200
        ],
        "y": []
      },
      "lines": [
        {
          "data": [
            1829,
            1498,
            1611
          ],
          "name": "created"
        }
      ]
    },
    "label": "Support volume",
    "legend": {
      "axes": {
        "x": "Creation date",
        "y": "Number of tickets"
      }
    }
  },
  "meta": {
    "start_datetime": "2020-06-10T00:00:00-05:00",
    "end_datetime": "2020-06-16T23:59:59-05:00",
    "previous_start_datetime": "2020-06-03T00:00:01-05:00",
    "previous_end_datetime": "2020-06-10T00:00:00-05:00",
    "next_cursor": "WyJuZXh0IiwgZmFsc2UsICJBbGV4IFBsdWdhcnUiLCAyXQ==",
    "prev_cursor": "WyJwcmV2IiwgZmFsc2UsICJCb2IgU21pdGgiLCAzXQ=="
  }
}