Retrieve historical aggregated callback offer 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

offers

object

1
{
2
  "data": {
3
    "offers": {
4
      "digital": {
5
        "totalRequestedCallback": 0
6
      },
7
      "totalOffers": 0,
8
      "voice": {
9
        "totalChoseMessaging": 0,
10
        "totalChoseToHold": 0,
11
        "totalIncompleteRegistration": 0,
12
        "totalRequestedCallback": 0
13
      }
14
    }
15
  }
16
}