Get Campaign Progress

GET /api/v1/campaign/{campaign_id}/progress — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/campaign/{campaign_id}/progress

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/campaign/{campaign_id}/progress \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "campaign_id": 1,
  "state": "<string>",
  "total_rows": 1,
  "processed_rows": 1,
  "failed_calls": 1,
  "progress_percentage": 1,
  "source_sync": {},
  "rate_limit": 1,
  "started_at": "2026-08-10T12:00:00Z",
  "completed_at": "2026-08-10T12:00:00Z"
}

get/api/v1/campaign/{campaign_id}/progress

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Path parameters

campaign_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

campaign_idintegerrequired#

statestringrequired#

total_rowsintegerrequired#

processed_rowsintegerrequired#

failed_callsintegerrequired#

progress_percentagenumberrequired#

source_syncobjectrequired#

rate_limitintegerrequired#

started_atstring · nullrequired#

Show child attributes

Any of

completed_atstring · nullrequired#

Show child attributes

Any of

Resume Campaign Get Campaign Source Download Url