Retrieve historical aggregated callback offer metrics by interval

Request

Security: OAuth 2.0

Query Parameters

callTargetId

string

Identifies which Call Target(s) to query (as a single value or a comma-separated list).

firstPartyCalled

string

Determines whether to include requests for Agent First or Customer First callbacks.

Allowed values:

agentcustomer

sourceType

string

Determines whether to include callback requests that came via phone or widget.

Allowed values:

digitalvoice

type

string

Determines whether to include callback requests registered as ASAP or scheduled.

Allowed values:

asapscheduled

interval

string

required

The time interval by which to aggregate metrics. The selected interval determines the maximum time span that can be queried: 15m = 3 days, 1h = 7 days, 1d = 30 days, 1W = 180 days (6 months), 1M = 730 days (2 years), 1Y = no restriction.

Allowed values:

15m1h1d1W1M1Y

timeBegin

string<date-time>

required

A timestamp (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ) determining the time from which metrics should be aggregated (inclusive).

timeEnd

string<date-time>

required

A timestamp (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ) determining the time up to which metrics should be aggregated (exclusive).

Responses

200

400

401

500

For a 200 response code, the response body is an object containing data, an aray of Callback offer metrics by interval.

Body

data

array[object]

intervalBegin

string<date-time>

The end timestamp of a given interval for which metrics are aggregated, exclusive. This should match the intervalBegin for the next chronological interval.

intervalEnd

string<date-time>

The beginning timestamp of a given interval for which metrics are calculated, inclusive.

partialInterval

boolean

Whether an aggregated interval only includes values calculated over part of the entire interval, caused by the requested start/end dates falling between an interval's start and end.

offers

object

1
{
2
  "data": [
3
    {
4
      "intervalBegin": "2019-08-24T14:15:22Z",
5
      "intervalEnd": "2019-08-24T14:15:22Z",
6
      "partialInterval": true,
7
      "offers": {
8
        "digital": {
9
          "totalRequestedCallback": 0
10
        },
11
        "totalOffers": 0,
12
        "voice": {
13
          "totalChoseMessaging": 0,
14
          "totalChoseToHold": 0,
15
          "totalIncompleteRegistration": 0,
16
          "totalRequestedCallback": 0
17
        }
18
      }
19
    }
20
  ]
21
}