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
Aggregate outbound-call KPIs 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>"
}
}Rolled-up counts for the given filters and time window: total calls, how many wer answered, how many are still in flight, how many hit an answering machine, and a breakdown by terminal outcome.
Authorizations
Project-bound Platform API key (abl_...). The key must carry outbound_calls.initiate
for write operations (initiate, terminate) or outbound_calls.read for read operations
(lookup, list, summary, search, event stream).
Path Parameters
The project's slug.
Minimum string length:
1Deployment environment segment the call runs under, e.g. production, staging, dev.
Minimum string length:
1Query Parameters
Restrict the summary to one channel connection.
Minimum string length:
1Inclusive ISO 8601 lower bound on call creation time.
Exclusive ISO 8601 upper bound on call creation time.
Was this page helpful?