Aggregate outbound-call KPIs for a time window
curl --request GET \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls/summary \
--header 'x-api-key: <api-key>'{
"success": true,
"data": {
"total": 128,
"answered": 91,
"inFlight": 3,
"machineDetected": 7,
"byOutcome": {
"completed": 84,
"no_answer": 22,
"busy": 4,
"canceled": 10,
"failed": 5,
"rejected": 2,
"expired": 1
}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}Summarize outbound calls
Get counts of total, answered, in-flight, and machine-detected outbound calls, and a breakdown by outcome, for a time window.
GET
/
api
/
v1
/
project
/
{projectSlug}
/
{env}
/
outbound-calls
/
summary
Aggregate outbound-call KPIs for a time window
curl --request GET \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls/summary \
--header 'x-api-key: <api-key>'{
"success": true,
"data": {
"total": 128,
"answered": 91,
"inFlight": 3,
"machineDetected": 7,
"byOutcome": {
"completed": 84,
"no_answer": 22,
"busy": 4,
"canceled": 10,
"failed": 5,
"rejected": 2,
"expired": 1
}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}outbound_calls.read scope.
Filter with channelConnectionId and a creation time window with from (inclusive) and to (exclusive). The answered count includes calls that reached in_progress at least once. The inFlight count includes calls that are not yet terminal. The byOutcome object counts terminal calls for each outcome.Authorizations
Path Parameters
Query Parameters
Was this page helpful?