Sign in
latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Analytics

Get calling analytics

REQUIRED SCOPES <code>['analytics:read']</code> <br> Retrieve statistics and charts for inbound and outbound calls within the specified time range.

get/core/analytics/calling

Query parameters

fromstring date required

Start date for the statistics range (YYYY-MM-DD)

tostring date required

End date for the statistics range (YYYY-MM-DD)

interval'day' | 'week' | 'month' | 'year' required

Interval for grouping the statistics

timezonestring required

Timezone in which the statistics should be calculated

filter[members]integer[]

Filter by members (comma-separated or array)

filter[inboxes]integer[]

Filter by inboxes (comma-separated or array)

filter[numbers]integer[]

Filter by numbers (comma-separated or array)

filter[tags]integer[]

Filter by tags (comma-separated or array)

Response

Successful response with calling analytics

Example response

{
  "statistic": [
    {
      "key": "outbound_calls",
      "label": "Outbound Calls",
      "value": 0,
      "prevValue": 0,
      "parent": ""
    },
    {
      "key": "inbound_calls",
      "label": "Inbound Calls",
      "value": 3,
      "prevValue": 8,
      "parent": ""
    },
    {
      "key": "avg_duration_outbound",
      "label": "Avg Duration Outbound",
      "value": 0,
      "prevValue": 0,
      "parent": "outbound_calls"
    },
    {
      "key": "answered_outbound",
      "label": "Answered Outbound",
      "value": 0,
      "prevValue": 0,
      "parent": "outbound_calls"
    },
    {
      "key": "unanswered_outbound",
      "label": "Unanswered Outbound",
      "value": 0,
      "prevValue": 0,
      "parent": "outbound_calls"
    },
    {
      "key": "busy_outbound",
      "label": "Busy Outbound",
      "value": 0,
      "prevValue": 0,
      "parent": "outbound_calls"
    },
    {
      "key": "failed_outbound",
      "label": "Failed Outbound",
      "value": 0,
      "prevValue": 0,
      "parent": "outbound_calls"
    },
    {
      "key": "avg_duration_inbound",
      "label": "Avg Duration Inbound",
      "value": 1,
      "prevValue": 0,
      "parent": "inbound_calls"
    },
    {
      "key": "answered_inbound",
      "label": "Answered Inbound",
      "value": 1,
      "prevValue": 0,
      "parent": "inbound_calls"
    },
    {
      "key": "answered_inbound_human",
      "label": "Answered Inbound Human",
      "value": 1,
      "prevValue": 0,
      "parent": "inbound_calls"
    },
    {
      "key": "answered_inbound_ai",
      "label": "Answered Inbound Ai",
      "value": 0,
      "prevValue": 0,
      "parent": "inbound_calls"
    },
    {
      "key": "missed_inbound",
      "label": "Missed Inbound",
      "value": 2,
      "prevValue": 8,
      "parent": "inbound_calls"
    },
    {
      "key": "busy_inbound",
      "label": "Busy Inbound",
      "value": 0,
      "prevValue": 0,
      "parent": "inbound_calls"
    },
    {
      "key": "failed_inbound",
      "label": "Failed Inbound",
      "value": 0,
      "prevValue": 0,
      "parent": "inbound_calls"
    },
    {
      "key": "forwarded",
      "label": "Forwarded",
      "value": 1,
      "prevValue": 0,
      "parent": ""
    },
    {
      "key": "avg_duration_forwarded",
      "label": "Avg Duration Forwarded",
      "value": 1,
      "prevValue": 0,
      "parent": "forwarded"
    }
  ],
  "charts": [
    {
      "date": "2025-01-10",
      "label": "2025-01-10",
      "inbound_calls": 3,
      "avg_duration_inbound": 1,
      "answered_inbound": 1,
      "answered_inbound_human": 1,
      "missed_inbound": 2,
      "forwarded": 1,
      "avg_duration_forwarded": 1
    }
  ]
}