Retrieve historical aggregated callback outcome metrics

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

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 object containing Callback outcome metrics.

Body

responses

200

data

object

outcomes

object

performance

object

totalCallbacks

integer

The total number of callbacks over the selected date range.

1
{
2
  "data": {
3
    "outcomes": {
4
      "totalAbandoned": 0,
5
      "totalCallbackASAP": 0,
6
      "totalCallbackScheduled": 0,
7
      "totalCanceled": 0,
8
      "totalFailure": 0,
9
      "totalSuccessful": 0,
10
      "totalUnavailable": 0
11
    },
12
    "performance": {
13
      "averageCallbackTime": 0,
14
      "averageCustomerWaitTime": 0,
15
      "averageEstimatedCallbackTime": 0,
16
      "averagePunctuality": 0,
17
      "averageTalkTime": 0,
18
      "maxCallbackTime": 0,
19
      "maxCustomerWaitTime": 0,
20
      "maxEstimatedCallbackTime": 0,
21
      "maxTalkTime": 0,
22
      "rcsl": {
23
        "totalAbove60": 0,
24
        "totalBelow30": 0,
25
        "totalBetween31_60": 0
26
      },
27
      "retries": {
28
        "'1'": {
29
          "totalAbandoned": 0,
30
          "totalCanceled": 0,
31
          "totalFailure": 0,
32
          "totalSuccessful": 0,
33
          "totalUnavailable": 0
34
        },
35
        "'2'": {
36
          "totalAbandoned": 0,
37
          "totalCanceled": 0,
38
          "totalFailure": 0,
39
          "totalSuccessful": 0,
40
          "totalUnavailable": 0
41
        },
42
        "'3'": {
43
          "totalAbandoned": 0,
44
          "totalCanceled": 0,
45
          "totalFailure": 0,
46
          "totalSuccessful": 0,
47
          "totalUnavailable": 0
48
        },
49
        "'4'": {
50
          "totalAbandoned": 0,
51
          "totalCanceled": 0,
52
          "totalFailure": 0,
53
          "totalSuccessful": 0,
54
          "totalUnavailable": 0
55
        },
56
        "'5'": {
57
          "totalAbandoned": 0,
58
          "totalCanceled": 0,
59
          "totalFailure": 0,
60
          "totalSuccessful": 0,
61
          "totalUnavailable": 0
62
        },
63
        "over5": {
64
          "totalAbandoned": 0,
65
          "totalCanceled": 0,
66
          "totalFailure": 0,
67
          "totalSuccessful": 0,
68
          "totalUnavailable": 0
69
        },
70
        "totalCallbacksWithRetries": 0,
71
        "totalRetryAttempts": 0
72
      },
73
      "totalRepeatCustomers": 0,
74
      "totalUniqueCustomers": 0
75
    },
76
    "totalCallbacks": 0
77
  }
78
}