Skip to content

Ads API •References / audiences / List Datasets eligible for creating Custom Audiences

List Datasets eligible for creating Custom Audiences

A list of datasets eligible for creating custom audiences

Request

ad_account_id
string [uuid]
Required
A unique identifier for an Ad Account.
Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
q
string
Query to search by keyword via case-insensitive wildcard matching.
Example: q=query
limit
integer
Limit or page size for a given response.
Default: limit=50Range: 1 - 50Example: limit=50

Response

A list of audiences.

- page_size
  integer [int32]
- total_results
  integer [int32]
- offset
  integer [int32]
- current_page
  integer [int32]
- id
  string [uuid]
  A unique identifier for the entity.
  Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- name
  string
  Name of the dataset.
  Example: "Spring Promotion Dataset"
- events
  array of strings
  Event names with activity for the dataset.
  Example: "add_to_cart"

Response sample

{  "paging": {    "page_size": 0,    "total_results": 0,    "offset": 0,    "current_page": 0  },  "datasets": [    {      "id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",      "name": "Spring Promotion Dataset",      "events": ["add_to_cart"]    }  ]}