Please ensure Javascript is enabled for purposes of website accessibility
Retrieve historical call data
  • 15 Mar 2024
  • 7 Minutes to read
  • Dark
    Light
  • PDF

Retrieve historical call data

  • Dark
    Light
  • PDF

Article Summary

Get
/v2/data/historical/{date}/{hour}
Security
OAuth
FlowClient credentials
Token URLhttps://auth.getmindful.com/oauth2/token
Scopes:
Path parameters
date
stringRequired

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

hour
stringRequired

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

Responses
200

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

Example ASAP Callback Object
{
  "activeDuration": 67.0,
  "actualCallbackTime": 10,
  "agentBusy": false,
  "agentDelay": 0,
  "agentHangup": false,
  "agentLegError": false,
  "agentLegRejected": false,
  "agentLegTimeout": false,
  "agentWaitDuration": null,
  "ani": "312-555-1212",
  "callTargetId": "5298",
  "callTargetName": "Calls test",
  "choseToHold": false,
  "createdAt": "2023-06-08T12:12:53Z",
  "customerBusy": false,
  "customerDelay": 0,
  "customerHangup": false,
  "customerLegError": false,
  "customerLegRejected": false,
  "customerLegTimeout": false,
  "customerRescheduled": false,
  "customerWaitDuration": null,
  "disconnectRescue": false,
  "duplicateCallback": false,
  "earlyHangup": false,
  "endOfBusinessDay": false,
  "endedAt": "2023-06-08T12:14:11Z",
  "estimatePercentAccuracy": 0.85111,
  "estimatedCallbackTime": 9,
  "estimatedFor": "2023-06-08T12:13:03Z",
  "firstPartyCalled": "customer_first",
  "hasRetry": false,
  "id": "e58de6e3788241e07",
  "leaveVoicemail": false,
  "maxEcbtExceeded": false,
  "maxScheduledCallsExceeded": false,
  "maxTollRateExceeded": false,
  "metadata": {},
  "nextDayCallbackOffered": false,
  "nextDayCallbackScheduled": false,
  "originalId": "e58de6e3788241e07",
  "outcome": "Unavailable",
  "outsideHours": false,
  "phoneNumber": "+13307526714",
  "priorityQueueTimedOut": false,
  "processedAt": "2023-06-08T12:13:03Z",
  "punctuality": 1,
  "registrationDuration": null,
  "retryAttempt": 0,
  "segmentName": null,
  "source": "CBWidget:dc4e66dd30d813202f6ccd7c20542525",
  "systemHangup": true,
  "talkDuration": null,
  "type": "asap",
  "waitlistDelay": 0,
  "wasPunctual": true
}
Example Scheduled Callback Object
{
  "activeDuration": 67.0,
  "actualCallbackTime": 10,
  "agentBusy": false,
  "agentDelay": 0,
  "agentHangup": false,
  "agentLegError": false,
  "agentLegRejected": false,
  "agentLegTimeout": false,
  "agentWaitDuration": null,
  "ani": "312-555-1212",
  "callTargetId": "5298",
  "callTargetName": "Calls test",
  "choseToHold": false,
  "createdAt": "2023-06-08T12:12:53Z",
  "customerBusy": false,
  "customerDelay": 0,
  "customerHangup": false,
  "customerLegError": false,
  "customerLegRejected": false,
  "customerLegTimeout": false,
  "customerRescheduled": false,
  "customerWaitDuration": null,
  "disconnectRescue": false,
  "duplicateCallback": false,
  "earlyHangup": false,
  "endOfBusinessDay": false,
  "endedAt": "2023-06-08T12:14:11Z",
  "estimatePercentAccuracy": 0.85111,
  "estimatedCallbackTime": 9,
  "estimatedFor": "2023-06-08T12:13:03Z",
  "firstPartyCalled": "customer_first",
  "hasRetry": false,
  "id": "e58de6e3788241e07",
  "leaveVoicemail": false,
  "maxEcbtExceeded": false,
  "maxScheduledCallsExceeded": false,
  "maxTollRateExceeded": false,
  "metadata": {},
  "nextDayCallbackOffered": false,
  "nextDayCallbackScheduled": false,
  "originalId": "e58de6e3788241e07",
  "outcome": "Unavailable",
  "outsideHours": false,
  "phoneNumber": "+13307526714",
  "priorityQueueTimedOut": false,
  "processedAt": "2023-06-08T12:13:03Z",
  "punctuality": 1,
  "registrationDuration": null,
  "retryAttempt": 0,
  "segmentName": null,
  "source": "CBWidget:dc4e66dd30d813202f6ccd7c20542525",
  "systemHangup": true,
  "talkDuration": null,
  "type": "asap",
  "waitlistDelay": 0,
  "wasPunctual": true
}
Expand All
object
data
Array of object (CallObject)
object
id
string

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

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.

callTargetId
string

Identifies which Call Target is associated with the callback request.

callTargetName
string

The name of the Call Target that processed this call.

segmentName
string

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.

ani
string

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

phoneNumber
string

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

type
string

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

Valid values[ "asap", "scheduled", "unknown" ]
firstPartyCalled
string

Indicates which party Mindful attempted to connect with first.

Valid values[ "agent_first", "customer_first" ]
registrationDuration
number

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

estimatedCallbackTime
number

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

actualCallbackTime
number

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.

outcome
string
Valid values[ "Abandon", "Canceled", "Chose Hold", "Failure", "Not Completed", "Success", "Unavailable" ]
createdAt
string

For first attempt callbacks, and calls without a callback, this is the RFC 3339-formatted 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.

estimatedFor
string

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

processedAt
string

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).

endedAt
string

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

waitlistDelay
number

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

estimatePercentAccuracy
number

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

punctuality
number

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.

customerDelay
number

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

agentDelay
number

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

customerWaitDuration
number

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

agentWaitDuration
number

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

talkDuration
number

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

activeDuration
number

The total duration, in seconds, of this call.

retryAttempt
number

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.

wasPunctual
boolean

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.

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.

choseToHold
boolean

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

duplicateCallback
boolean

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

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.

endOfBusinessDay
boolean

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

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.

maxEcbtExceeded
boolean

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

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.

priorityQueueTimedOut
boolean

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

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.

customerRescheduled
boolean

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

Where the callback is rescheduled by the customer in this way, a subsequent call will be created. The value of orginalId for the subsequent call will be the same as the value of originalId for this call.

earlyHangup
boolean

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

customerHangup
boolean

Indicates whether the customer hung up first.

agentHangup
boolean

Indicates whether the agent hung up first.

systemHangup
boolean

Indicates whether the system intitated the disconnect.

customerLegError
boolean

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

agentLegError
boolean

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

customerBusy
boolean

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

agentBusy
boolean

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

customerLegRejected
boolean

Indicates whether the customer leg attempt was rejected.

agentLegRejected
boolean

Indicates whether the agent leg attempt was rejected.

customerLegTimeout
boolean

Indicates whether there was a timeout on the customer leg.

agentLegTimeout
boolean

Indicates whether there was a timeout on the agent leg.

leaveVoicemail
boolean

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

maxScheduledCallsExceeded
boolean

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

metadata
object

An object describing metadata submitted with a callback registration.

400

Request failed validation, or date parameter is not correctly formatted

404

No data available for the given date and hour

500

Internal or system-related error


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.