Get Campaign Runs

Retrieve individual run records for each contact in a campaign

1 min read

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

Request example

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

Response

{
  "runs": [
    {}
  ],
  "total_count": 1,
  "page": 1,
  "limit": 1,
  "total_pages": 1
}

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

Returns the individual run records for each contact in the campaign. Each record includes the same fields as agent run details, including run status, duration, transcript, and recording URL.

Path parameters

campaign_idintegerrequired#

Query parameters

pageinteger#

Page number (starts from 1)

Default: 1

Range: >= 1

limitinteger#

Number of items per page

Default: 50

Range: 1–100

filtersstring · null#

JSON-encoded filter criteria

sort_bystring · null#

Field to sort by (e.g., 'duration', 'created_at')

sort_orderstring · null#

Sort order ('asc' or 'desc')

Default: "desc"

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

runsobject[]required#

total_countintegerrequired#

pageintegerrequired#

limitintegerrequired#

total_pagesintegerrequired#

Get Campaign Progress Overview