Get Audience Pipeline Status

GET

/campaigns/{campaign_id}/audience-pipeline/status

Production
QA

SPENDS NOTHING. Where the campaign’s audience pipeline is, and what it has produced: the list it built, how many contacts, the enrichment job, the keywords it provisioned, and the error if it failed.

Authorizations

BearerAuth

Parameters

Path Parameters

campaign_id

required

Campaign id or slug; resolved inside the key’s organisation.

string

Campaign id or slug; resolved inside the key’s organisation.

Header Parameters

X-Target-Org-Id

Any of:

string
null

string

Responses

200

Successful Response

object

data

required

Mirrors AudiencePipelineStatusResponse. Where the pipeline is, and what it has produced so far.

object

completed_at

Any of:

string
null

string format: date-time

enrichment_job_id

Any of:

string
null

string

error

Any of:

string
null

string

keyword_ids

Any of:

Array<string>
null

Array<string>

list_id

Any of:

string
null

string

pipeline_status

string

default: idle

started_at

Any of:

string
null

string format: date-time

suggested_filters

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

suggested_list_name

Any of:

string
null

string

total_contacts

integer

pagination

Any of:

PaginationMeta
null

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string
null

string

notes

Any of:

Array<string>
null

Array<string>

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer
null

integer

total_is_lower_bound

Any of:

boolean
null

boolean

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string