Skip to main content
GET
Get Campaign Progress

Authorizations

X-API-Key
string
header
required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization
string | null
X-API-Key
string | null

Path Parameters

campaign_id
integer
required

Response

Successful Response

campaign_id
integer
required
state
string
required
total_rows
integer
required
processed_rows
integer
required
failed_calls
integer
required
progress_percentage
number
required
source_sync
object
required
rate_limit
integer
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
scheduled_start_at
string<date-time> | null
calling_window
object | null
calling_window_open
boolean
default:true
next_window_open_at
string<date-time> | null