List audiences
list_audiencesSee which audiences this workspace can ask. Free, and the first step of everything else:
a study needs an audience id from here.
Each entry says what it is (kind), how big (size, with size_scope and whether the size is
measured or estimated), where its answers come from (provenance: anchored = real respondents'
own answers, verified = sized on measured population data, calibrated = matched to real survey
data, model_est = modelled only), and its definition split into measured / estimated / unsupported
criteria. A locked official audience shows only its unlock card.Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Most audiences to return, 1 to 200 | |
| query | No | Substring to match in the audience name or description | |
| scope | No | own = built in this workspace; market = the measured population of each market the workspace holds; official = curated calibrated audiences; all (default) | all |
| country | No | Filter by country name as iMario spells it, e.g. 'United States', 'Germany', 'China' |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | false means the call failed: read `error` and `hint` | |
| hint | No | What to change, when ok is false | |
| next | No | What to do next | |
| note | No | Something to tell the user or keep in mind | |
| error | No | Error code, when ok is false | |
| audiences | No | Each: id, name, kind, size, size_scope, provenance, definition {measured, estimated, unsupported} | |
| markets_held | No | Countries whose measured populations this workspace may ask |