Skip to main content
GET
/
campaigns
/
{campaign_id}
Get Campaign Status
curl --request GET \
  --url https://api.example.com/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>'
{
  "campaign_id": "<string>",
  "status": "<string>",
  "progress": 123,
  "calls_initiated": 123,
  "calls_completed": 123,
  "calls_failed": 123,
  "calls_pending": 123,
  "started_at": "<string>",
  "completed_at": "<string>",
  "estimated_completion": "<string>",
  "target_errors": [
    {}
  ],
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mrassistant.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
string
required

Response

Successful Response

Campaign status response.

​
campaign_id
string
required
​
status
string
required
​
progress
number
required
​
calls_initiated
integer
required
​
calls_completed
integer
required
​
calls_failed
integer
required
​
calls_pending
integer
required
​
started_at
string | null
required
​
completed_at
string | null
required
​
estimated_completion
string | null
required
​
target_errors
Target Errors · object[] | null
​
error
string | null