Skip to content

campaigns.summary

Outcomes and cost so far.

Reference

GET/api/v1/campaigns/{campaign_id}/summary

Auth
API key in X-API-Key
Content
none
Returns
200 · Response Get Campaign Summary Api V1 Campaign Campaign Id Summary Get

Aggregate campaign performance: rates, retries, languages, daily progress. The companion to `/report`, which streams a row per call. A tender asks for connection and completion rates, retry statistics, language distribution and progress by day (Telangana §10), and none of those are answerable from a CSV without the reader re-deriving them — and picking their own denominators while they do it. The definitions live in `services/reports/campaign_summary.py` and match the admin dashboard's, so this and `/admin/billing/campaigns` cannot disagree about the same campaign.

Arguments

ArgumentInTypeRequiredDescription
campaign_idpathintegerrequired

Example request

curl -X GET "https://api.decibyl.ai/api/v1/campaigns/<campaign_id>/summary" \
  -H "X-API-Key: dcb_your_key"

Response

{}

Errors

StatusWhen
404Not found
422Validation Error