Retrieve historical aggregated callback outcome metrics by interval

get
https://{api-gateway-hostname}
/v2/callback/historical/metrics/intervals
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).

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

responses
/
200
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.

outcomes
object
performance
object
totalCallbacks
integer

The total number of callbacks over the selected date range.

Auth
:
Server Variables
:
Parameters
:
:
:
:
:
:
:
curl --request GET \
--url 'https://api.getmindful.com/v2/callback/historical/metrics/intervals?interval=15m' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 123'
Response Example
1
{
2
"data": [
3
{
4
"intervalBegin": "2019-08-24T14:15:22Z",
5
"intervalEnd": "2019-08-24T14:15:22Z",
6
"partialInterval": true,
7
"outcomes": {
8
"totalAbandoned": 0,
9
"totalCallbackASAP": 0,
10
"totalCallbackScheduled": 0,
11
"totalCanceled": 0,
12
"totalFailure": 0,
13
"totalSuccessful": 0,
14
"totalUnavailable": 0
15
},
16
"performance": {
17
"averageCallbackTime": 0,
18
"averageCustomerWaitTime": 0,
19
"averageEstimatedCallbackTime": 0,
20
"averagePunctuality": 0,
21
"averageTalkTime": 0,
22
"maxCallbackTime": 0,
23
"maxCustomerWaitTime": 0,
24
"maxEstimatedCallbackTime": 0,
25
"maxTalkTime": 0,
26
"rcsl": {
27
"totalAbove60": 0,
28
"totalBelow30": 0,
29
"totalBetween31_60": 0
30
},
31
"retries": {
32
"'1'": {
33
"totalAbandoned": 0,
34
"totalCanceled": 0,
35
"totalFailure": 0,
36
"totalSuccessful": 0,
37
"totalUnavailable": 0
38
},
39
"'2'": {
40
"totalAbandoned": 0,
41
"totalCanceled": 0,
42
"totalFailure": 0,
43
"totalSuccessful": 0,
44
"totalUnavailable": 0
45
},
46
"'3'": {
47
"totalAbandoned": 0,
48
"totalCanceled": 0,
49
"totalFailure": 0,
50
"totalSuccessful": 0,
51
"totalUnavailable": 0
52
},
53
"'4'": {
54
"totalAbandoned": 0,
55
"totalCanceled": 0,
56
"totalFailure": 0,
57
"totalSuccessful": 0,
58
"totalUnavailable": 0
59
},
60
"'5'": {
61
"totalAbandoned": 0,
62
"totalCanceled": 0,
63
"totalFailure": 0,
64
"totalSuccessful": 0,
65
"totalUnavailable": 0
66
},
67
"over5": {
68
"totalAbandoned": 0,
69
"totalCanceled": 0,
70
"totalFailure": 0,
71
"totalSuccessful": 0,
72
"totalUnavailable": 0
73
},
74
"totalCallbacksWithRetries": 0,
75
"totalRetryAttempts": 0
76
},
77
"totalRepeatCustomers": 0,
78
"totalUniqueCustomers": 0
79
},
80
"totalCallbacks": 0
81
}
82
]
83
}