curl --request GET \
--url https://{host}/api/v1/campaigns/{id}/results \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/campaigns/{id}/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/campaigns/{id}/results"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"attempts": 123,
"contact_id": "<string>",
"disposition": "<string>",
"e164": "<string>",
"last_attempt_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"outcome": "<string>",
"reference": "<string>",
"result_at": "2023-11-07T05:31:56Z",
"variables": {}
}
],
"limit": 123,
"offset": 123,
"total": 123
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Each contact's final outcome
Newest first. A contact’s outcome is final when nothing more will be done: done, or every attempt used. outcome is reached, not_reached, bad_number, suppressed, failed or unknown; disposition is the exact result. The same data campaign.contact.completed carried — read this to catch up after a missed callback. Requires campaigns:read.
curl --request GET \
--url https://{host}/api/v1/campaigns/{id}/results \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/campaigns/{id}/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/campaigns/{id}/results"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"attempts": 123,
"contact_id": "<string>",
"disposition": "<string>",
"e164": "<string>",
"last_attempt_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"outcome": "<string>",
"reference": "<string>",
"result_at": "2023-11-07T05:31:56Z",
"variables": {}
}
],
"limit": 123,
"offset": 123,
"total": 123
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Authorizations
Every request sends Authorization: Bearer <token>. The token is either a panel session (a JWT from /auth/login, 12 hours) or an API key ft_<id>_<secret>. An API key is accepted only from an address on its IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required for an old key that has none), is limited to its rate per minute (429 rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on every response), and at most 60 call placements a minute.
Path Parameters
Query Parameters
x <= 500reached, not_reached, bad_number, suppressed, failed