Skip to main content
POST
Search platform audiences

Authorizations

Authorization
string
header
required

Body

application/json

Audience search request payload.

Request payload for audience search.

search_term
string
required

Required text filter for audience title and description.

Example:

"gen z"

dataset_codes
string[]

Optional dataset codes used to scope results.

Example:
exclude_audience_ids
string[]

Optional audience UUIDs to exclude from results.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:
limit
integer
default:20

Optional maximum number of audiences to return (1-100). Omit to use the service default 20.

Required range: 1 <= x <= 100
Example:

8

Response

Successful response

Response payload for audience search.

audiences
object[]
required

Matching audiences.