Get Campaign Results
Get detailed information and results for a specific campaign
curl --request GET \
--url https://my.cald.ai/client/api/v1/campaigns/{campaignId}/details \
--header 'Authorization: <api-key>'{
"campaignId": "<string>",
"name": "<string>",
"listId": "<string>",
"agentId": "<string>",
"status": "<string>",
"stats": {
"totalCalls": 123,
"completedCalls": 123,
"failedCalls": 123,
"pendingCalls": 123,
"pickedUpCalls": 123,
"ivrCalls": 123,
"voicemailCalls": 123,
"unansweredCalls": 123,
"disconnectedCalls": 123
},
"calls": [
{
"callId": "<string>",
"direction": "<string>",
"from": "<string>",
"to": "<string>",
"completed": true,
"result": "<string>",
"createdAt": "<string>",
"completedAt": "<string>",
"transcripts": [
{
"role": "<string>",
"content": "<string>"
}
],
"callLength": 123,
"recordingUrl": "<string>"
}
]
}Authorizations
Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Path Parameters
The campaign ID of the campaign
Response
The campaign ID of the campaign
The name given to the campaign in the MyCald Dashboard
The list ID of the list used for the campaign
The agent ID of the agent used for the campaign
The status of the campaign, can be pending, active, not_funded, finished, cancelled
Total number of calls in the campaign
Number of calls that have been completed
Number of calls that have failed
Number of calls that are pending
Number of calls that have been picked up
Number of calls that have been answered by an IVR
Number of calls that have been answered by a voicemail
Number of calls that have been unanswered
Number of calls that have been disconnected
Unique identifier for the call
Direction of the call, can be outbound or inbound
Phone number that initiated the call. In the case of an outbound call, this is the phone number that Cald used ot make the call. In the case of an inbound call, this is the phone number of the prospect/lead that called.
Phone number that received the call. In the case of an outbound call, this is the phone number of the prospect/lead that was called. In the case of an inbound call, this is the phone number of the agent that was called.
Whether the call has been completed
Result of the call, can be pending, pickedUp, ivr, voicemail, unanswered, disconnected, failed. If the machine check isn't enabled in the agent's settings, the ivr or voicemail result will never be returned.
Date and time the call was initiated
Date and time the call was completed (not present if the call isn't completed)
Length of the call in seconds (not present if the call isn't completed)
URL of the recording of the call (not present if the call isn't completed or if recording isn't enabled)
curl --request GET \
--url https://my.cald.ai/client/api/v1/campaigns/{campaignId}/details \
--header 'Authorization: <api-key>'{
"campaignId": "<string>",
"name": "<string>",
"listId": "<string>",
"agentId": "<string>",
"status": "<string>",
"stats": {
"totalCalls": 123,
"completedCalls": 123,
"failedCalls": 123,
"pendingCalls": 123,
"pickedUpCalls": 123,
"ivrCalls": 123,
"voicemailCalls": 123,
"unansweredCalls": 123,
"disconnectedCalls": 123
},
"calls": [
{
"callId": "<string>",
"direction": "<string>",
"from": "<string>",
"to": "<string>",
"completed": true,
"result": "<string>",
"createdAt": "<string>",
"completedAt": "<string>",
"transcripts": [
{
"role": "<string>",
"content": "<string>"
}
],
"callLength": 123,
"recordingUrl": "<string>"
}
]
}