Skip to main content
GET
Get final campaign analysis by campaign ID

Authorizations

api_key
string
header
required

Headers

Company-Name
string
required

The name of the schema to be used for the request

Path Parameters

campaign_id
string
required

Unique campaign ID (e.g., quickcamp6cd8c4ce)

Response

Final campaign analysis data response

status_counts
object
required

Counts of each call status in the campaign (e.g., AGENT_HANGUP, DIAL_NO_ANSWER)

Example:
outcome_counts
object
required

Counts of each outcome classification (e.g., POSITIVE, NEGATIVE, UNKNOWN)

Example:
number_of_callbacks
object
required

Details or count of scheduled callbacks if any (can be empty)

Example:
cumulative_user_hangups
string[]
required

List of user IDs or identifiers who hung up the call (can be empty)

Example:
response_sentiment_counts
object
required

Count of response sentiments detected during the campaign

Example:
improvement_tag_counts
object
required

Counts of improvement tags used in the campaign

Example:
analysis_dict
object
required

Final summary and aggregated metrics of the campaign