List audiences
GET {{baseUrl}}/ad_accounts/:ad_account_id/audiences?audience_ids=0063752&audience_type=88006977&audience_types=ACTALIKE&bookmark=est occaecat&entity_statuses=ACTIVE&entity_statuses=ACTIVE&flatten_rule=true&order=ASCENDING&order_by=NAME&page_size=25&search_query=est occaecat&start_index=88006977
This endpoint is currently in beta and not available to all apps. Learn more.
Get list of audiences for the ad account.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
audience_ids | string | List of audience ids to use to filter the results. | |
audience_type | number | The type of audience to filter for. | |
audience_types | string | The types of audience to filter for. | |
bookmark | string | Cursor used to fetch the next page of items | |
entity_statuses | string | Entity status | |
entity_statuses | string | Entity status | |
flatten_rule | boolean | Uniform the format of Audiences rules for presentation on Web UI. | |
order | string | The order in which to sort the items returned: “ASCENDING” or “DESCENDING” | |
| by ID. Note that higher-value IDs are associated with more-recently added | |||
| items. | |||
order_by | string | The audience field to order results by. | |
page_size | number | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information. | |
search_query | string | String keywords to search for audiences by. | |
start_index | number | he starting index for returned list. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"ad_account_id":"549755885175","id":"1234","name":"ACME Tools","audience_type":"cillum laborum ex consequat fugiat","description":"People who love making quilts.","rule":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":1000,"status":"consequat","type":"audience","created_timestamp":1451431341,"updated_timestamp":1451431341},{"ad_account_id":"549755885175","id":"1234","name":"ACME Tools","audience_type":"cupidatat proident nisi nulla fugiat","description":"People who love making quilts.","rule":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":1000,"status":"cillum ipsum occaecat minim","type":"audience","created_timestamp":1451431341,"updated_timestamp":1451431341}],"bookmark":"elit ut nisi magna"}