List audiences
GET {{baseUrl}}/ad_accounts/:ad_account_id/audiences?bookmark=<string>&order=ASCENDING&page_size=25&ownership_type=OWNED
Get list of audiences for the ad account.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
bookmark | string | Cursor used to fetch the next page of items | |
order | string | The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. | |
For received audiences, it is sorted by sharing event time. | |||
Note that higher-value IDs are associated with more-recently added items. | |||
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. | |
ownership_type | string | <strong>This feature is currently in beta and not available to all apps.</strong> | |
Filter audiences by ownership type. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"ad_account_id":"31670465572","id":"38873561","name":"\u003cstring\u003e","audience_type":"\u003cstring\u003e","description":"\u003cstring\u003e","rule":{"country":"\u003cstring\u003e","customer_list_id":"095771326","engagement_domain":["\u003cstring\u003e","\u003cstring\u003e"],"engagement_type":"\u003cstring\u003e","event":"\u003cstring\u003e","event_data":{"currency":"RON","lead_type":"\u003cstring\u003e","line_items":{"product_brand":"\u003cstring\u003e","product_category":"\u003cstring\u003e","product_id":"\u003cinteger\u003e","product_name":"\u003cstring\u003e","product_price":"\u003cstring\u003e","product_quantity":"\u003cinteger\u003e","product_variant":"\u003cstring\u003e","product_variant_id":"\u003cstring\u003e"},"order_id":"\u003cstring\u003e","order_quantity":"\u003cinteger\u003e","page_name":"\u003cstring\u003e","promo_code":"\u003cstring\u003e","property":"\u003cstring\u003e","search_query":"\u003cstring\u003e","value":"\u003cstring\u003e","video_title":"\u003cstring\u003e"},"percentage":"\u003cinteger\u003e","pin_id":["196","0731931740"],"prefill":"\u003cboolean\u003e","retention_days":"\u003cinteger\u003e","seed_id":["8","4461"],"url":["\u003cstring\u003e","\u003cstring\u003e"],"visitor_source_id":"83644031391","event_source":{},"ingestion_source":{},"engager_type":"\u003cinteger\u003e","campaign_id":["1","7194"],"ad_id":["014","36"],"objective_type":["WEB_CONVERSION","CONSIDERATION"],"ad_account_id":"633"},"size":"\u003cinteger\u003e","status":"\u003cstring\u003e","type":"\u003cstring\u003e","created_timestamp":"\u003cinteger\u003e","updated_timestamp":"\u003cinteger\u003e"},{"ad_account_id":"83605487579","id":"8670","name":"\u003cstring\u003e","audience_type":"\u003cstring\u003e","description":"\u003cstring\u003e","rule":{"country":"\u003cstring\u003e","customer_list_id":"08","engagement_domain":["\u003cstring\u003e","\u003cstring\u003e"],"engagement_type":"\u003cstring\u003e","event":"\u003cstring\u003e","event_data":{"currency":"BRL","lead_type":"\u003cstring\u003e","line_items":{"product_brand":"\u003cstring\u003e","product_category":"\u003cstring\u003e","product_id":"\u003cinteger\u003e","product_name":"\u003cstring\u003e","product_price":"\u003cstring\u003e","product_quantity":"\u003cinteger\u003e","product_variant":"\u003cstring\u003e","product_variant_id":"\u003cstring\u003e"},"order_id":"\u003cstring\u003e","order_quantity":"\u003cinteger\u003e","page_name":"\u003cstring\u003e","promo_code":"\u003cstring\u003e","property":"\u003cstring\u003e","search_query":"\u003cstring\u003e","value":"\u003cstring\u003e","video_title":"\u003cstring\u003e"},"percentage":"\u003cinteger\u003e","pin_id":["2","431399738"],"prefill":"\u003cboolean\u003e","retention_days":"\u003cinteger\u003e","seed_id":["4","49060136"],"url":["\u003cstring\u003e","\u003cstring\u003e"],"visitor_source_id":"715","event_source":{},"ingestion_source":{},"engager_type":"\u003cinteger\u003e","campaign_id":["82623","3986"],"ad_id":["9","9"],"objective_type":["AWARENESS","CATALOG_SALES"],"ad_account_id":"06372"},"size":"\u003cinteger\u003e","status":"\u003cstring\u003e","type":"\u003cstring\u003e","created_timestamp":"\u003cinteger\u003e","updated_timestamp":"\u003cinteger\u003e"}],"bookmark":"\u003cstring\u003e"}