Audiences

List Audiences

get

Returns all your saved audiences.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Query parameters
pageinteger · min: 1Optional

Page number

Default: 1
sizeinteger · min: 1 · max: 100Optional

Page size

Default: 50
Responses
200

Successful Response

application/json
totalintegerRequired
pageinteger · min: 1Required
sizeinteger · min: 1Required
pagesintegerRequired
get
/audiences

Create Audience

post

Creates a new audience from the provided filters. Building happens asynchronously in the background — the audience will have status: queued until the build completes.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Body
namestringRequired

A name for this audience.

descriptionany ofOptional
stringOptional
or
nullOptional
lookback_windowany ofOptional

How many days of session history to include when building the audience.

Default: 60
integer · min: 1Optional
or
nullOptional
refresh_cronany ofOptionalDefault: 55 15 * * *
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
idstringRequired
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
members_countany ofOptional
integerOptional
or
nullOptional
filtersany ofOptional
or
nullOptional
lookback_windowany ofOptional
integerOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
userany ofOptional
stringOptional
or
nullOptional
last_syncedany ofOptional
string · date-timeOptional
or
nullOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
post
/audiences

Get Audience

get

Returns a single audience by ID, including its filters and current build status.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Responses
200

Successful Response

application/json
idstringRequired
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
members_countany ofOptional
integerOptional
or
nullOptional
filtersany ofOptional
or
nullOptional
lookback_windowany ofOptional
integerOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
userany ofOptional
stringOptional
or
nullOptional
last_syncedany ofOptional
string · date-timeOptional
or
nullOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get
/audiences/{id}

Delete Audience

delete

Deletes an audience and all its members.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Responses
200

Successful Response

application/json
idstringRequired
namestringRequired
messagestringRequired
delete
/audiences/{id}

Refresh Audience

post

Triggers a rebuild of the audience. Returns 400 if the audience is already syncing.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Responses
200

Successful Response

application/json
audience_idstringRequired
namestringRequired
statusany ofOptional
stringOptional
or
nullOptional
post
/audiences/{id}/refresh

List Audience Members

get

Returns the visitor profiles that belong to this audience.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Query parameters
pageinteger · min: 1Optional

Page number

Default: 1
sizeinteger · min: 1 · max: 100Optional

Page size

Default: 50
Responses
200

Successful Response

application/json
totalintegerRequired
pageinteger · min: 1Required
sizeinteger · min: 1Required
pagesintegerRequired
get
/audiences/{id}/members

Last updated

Was this helpful?