Retrieve historical call data

get
https://{api-gateway-hostname}
/v2/data/historical/{date}/{hour}
date
string
required

A UTC date in the format 'YYYYMMDD' (e.g., 20230207)

hour
string
required

The given hour offset from midnight in the format 'HH'. As an example, a value of 04 corresponds to the historical data available between 3:00 AM UTC and 4:00 AM UTC on the given date

For a 200 response code, the response body is an object containing data, which is an array of individual callback record objects.

responses
/
200
data
array[object]

The list of Call Objects.

activeDuration
integer

The total duration, in seconds, of this call.

actualCallbackTime
integer or null

The actual duration, in seconds, that the customer was waiting for their callback, based on the difference between the createdAt time and the processedAt time.

agentBusy
boolean

Indicates whether the attempt to reach the agent resulted in a busy signal.

agentDelay
integer

The time, in seconds, the customer spent waiting for the agent to connect.

agentHangup
boolean

Indicates whether the agent hung up first.

agentLegError
boolean

Indicates whether there was an error on the agent leg of the callback attempt.

agentLegRejected
boolean

Indicates whether the agent leg attempt was rejected.

agentLegTimeout
boolean

Indicates whether there was a timeout on the agent leg.

agentWaitDuration
integer or null

The length of time, in seconds, the agent waited for the other party.

ani
string

For calls in the voice channels, the ANI of the inbound call to Mindful.

callTargetId
string

Identifies which Call Target is associated with the callback request.

callTargetName
string

The name of the Call Target that processed this call.

choseToHold
boolean

For inbound calls in the voice channel, indicates whether the caller chose to hold in person for an agent.

createdAt
string

For first attempt callbacks, and calls without a callback, this is the RFC 3339-formatted UTC timestamp at which Mindful first became aware of the call. For subsequent attempts, and rescheduled callbacks, this is the timestamp at which the retry was created by the previous attempt.

customerBusy
boolean

Indicates whether the attempt to reach the caller resulted in a busy signal.

customerDelay
integer

The elapsed time, in seconds, before the customer acknowledged the callback by pressing '1'.

customerHangup
boolean

Indicates whether the customer hung up first.

customerLegError
boolean

Indicates whether there was an error on the customer leg of the callback attempt.

customerLegRejected
boolean

Indicates whether the customer leg attempt was rejected.

customerLegTimeout
boolean

Indicates whether there was a timeout on the customer leg.

customerRescheduled
boolean

Indicates whether the customer chose to reshedule this callback for a later time.Show all...

customerWaitDuration
integer or null

The length of time, in seconds, between an Agent accepting a Callback and their call being connected with the Customer.

disconnectRescue
boolean

Indicates whether the call was initially delivered to an agent who did not accept the call, resulting in the call being delivered to another agent.

duplicateCallback
boolean

Indicates whether an attempt was made to register a callback to a phone number that Mindful considered a Duplicate Callback Request.

earlyHangup
boolean

Indicates whether the inbound caller hung up before all of the requested metadata was collected.

endOfBusinessDay
boolean

Indicates whether a call arrived during a time period Mindful considered End of Business Day.

endedAt
string<date-time>

An RFC 3339-formatted UTC timestamp representing the time at which the callback attempt ended.

estimatePercentAccuracy
number

The delta, in seconds, between estimatedCallbackTime and actualCallbackTime, represented as a percentage of the estimatedCallbackTime.

estimatedCallbackTime
integer or null

An estimate of the duration, in seconds, that a customer would be waiting for their callback, calculated at the time the callback was registered.

estimatedFor
string<date-time> or null

For callbacks, the RFC 3339-formatted UTC timestamp at which the callback was expected to be processed.

firstPartyCalled
string

Indicates which party Mindful attempted to connect with first.

Allowed values:
agentcustomer
hasRetry
boolean

Indicates whether another callback attempt will be made after this call. The value of originalId for any subsequent retries will be the same as the value of originalId for this call.

id
string

The identifier for this call attempt; used with originalId to tie all related call attempts together.

leaveVoicemail
boolean

Indicates whether a voicemail was left. Applies to callbacks where the first party called was an agent.

maxEcbtExceeded
boolean

Indicates whether ECBT exceeded the configured ECBT Threshold when this call arrived. Not implemented for digital callbacks.

maxScheduledCallsExceeded
boolean

Indicates whether the maximum scheduled calls was exceeded for the timeslot a scheduled callback was requested for.

maxTollRateExceeded
boolean

Indicates whether an attempt was made to register a callback to a phone number whose per minute toll charges exceed the maximum rate permitted.

metadata
dictionary[string, string]

An object describing metadata submitted with a callback registration.

nextDayCallbackOffered
boolean

For calls arriving to Mindful during the End of Business Day period, indicates whether the option to request a callback during the next business day was offered.

nextDayCallbackScheduled
boolean

For calls where a callback during the next business day was offered, indicates whether that option was accepted.

originalId
string

The original dispatch ID associated with the callback request. For calls that are a retry or rescheduled callback, this is the ID of the original call.

outcome
string
Allowed values:
AbandonCanceledChose HoldFailureNot CompletedSuccessUnavailable
outsideHours
boolean

Indicates whether an attempt to register a callback was made outside of the Business Hours configured for the Call Target or Segment that processed this callback request.

phoneNumber
string

For callbacks, this is the number the callback was registered for.

priorityQueueTimedOut
boolean

Indicates whether the Priority Queue Timeout was exceeded on the agent leg of the call.

processedAt
string<date-time> or null

An RFC 3339-formatted UTC timestamp representing the time at which the first leg of the callback was launched (to either the customer or contact center).

punctuality
integer or null

The time, in seconds, between the estimatedFor and processedAt timestamps. Positive numbers indicate how many seconds late a callback was. Negative numbers indicate how many seconds early a callback was.

registrationDuration
integer or null

The duration, in seconds, that a customer spent registering their callback via the voice channel.

retryAttempt
integer

For calls that are retry callbacks, this number represents what number retry it was. 1 indicates this was the first retry after the original attempt, the original attempt being the call referenced by originalId.

segmentName
string or null

The name of the Segment that processed this call. If null, the call was not processed by a Segment.

source
string

The Phone Number or Widget that was used to register this Callback.

systemHangup
boolean

Indicates whether the system intitated the disconnect.

talkDuration
integer or null

The length of time, in seconds, that the customer and agent were connected to each other.

type
string

For callbacks, this is either asap or scheduled. For other call types, this is unknown.

Allowed values:
asapscheduledunknown
waitlistDelay
number

The length of time, in seconds, the callback spent in the waitlist, which is the difference between the Waitlisted and Dispatched events.

wasPunctual
boolean or null

For callbacks that were launched within the range quoted within the range calculated at the time of registration, this is true. For callbacks that were launched early or late, this is false.

Auth
:
Server Variables
:
Parameters
:
:
curl --request GET \
--url https://api.getmindful.com/v2/data/historical/date/hour \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 123'
1
{
2
"data": [
3
{
4
"activeDuration": 0,
5
"actualCallbackTime": 10,
6
"agentBusy": false,
7
"agentDelay": 0,
8
"agentHangup": false,
9
"agentLegError": false,
10
"agentLegRejected": false,
11
"agentLegTimeout": false,
12
"agentWaitDuration": 10,
13
"ani": "13125551212",
14
"callTargetId": "5298",
15
"callTargetName": "Calls test",
16
"choseToHold": false,
17
"createdAt": "2023-06-08T12:12:53.000Z",
18
"customerBusy": false,
19
"customerDelay": 0,
20
"customerHangup": false,
21
"customerLegError": false,
22
"customerLegRejected": false,
23
"customerLegTimeout": false,
24
"customerRescheduled": false,
25
"customerWaitDuration": null,
26
"disconnectRescue": false,
27
"duplicateCallback": false,
28
"earlyHangup": false,
29
"endedAt": "2023-06-08T12:14:11.000Z",
30
"endOfBusinessDay": false,
31
"estimatedCallbackTime": 9,
32
"estimatedFor": "2023-06-08T12:13:03.000Z",
33
"estimatePercentAccuracy": 0.85111,
34
"firstPartyCalled": "customer",
35
"hasRetry": false,
36
"id": "e58de6e3788241e07",
37
"leaveVoicemail": false,
38
"maxEcbtExceeded": false,
39
"maxScheduledCallsExceeded": false,
40
"maxTollRateExceeded": false,
41
"metadata": {},
42
"nextDayCallbackOffered": false,
43
"nextDayCallbackScheduled": false,
44
"originalId": "e58de6e3788241e07",
45
"outcome": "Unavailable",
46
"outsideHours": false,
47
"phoneNumber": "+13307526714",
48
"priorityQueueTimedOut": false,
49
"processedAt": "2023-06-08T12:13:03.000Z",
50
"punctuality": 1,
51
"registrationDuration": null,
52
"retryAttempt": 0,
53
"segmentName": null,
54
"source": "CBWidget:dc4e66dd30d813202f6ccd7c20542525",
55
"systemHangup": true,
56
"talkDuration": null,
57
"type": "asap",
58
"waitlistDelay": 0,
59
"wasPunctual": true
60
}
61
]
62
}