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_idstring [uuid]
    Required

    A unique identifier for an Ad Account.

    Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
  • qstring

    Query to search by keyword via case-insensitive wildcard matching.

    Example: q=query
  • limitinteger

    Limit or page size for a given response.

    Default: limit=50Range: 1 - 50Example: limit=50

Response

A list of audiences.

    • page_sizeinteger [int32]
    • total_resultsinteger [int32]
    • offsetinteger [int32]
    • current_pageinteger [int32]
    • idstring [uuid]

      A unique identifier for the entity.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
    • namestring

      Name of the dataset.

      Example: "Spring Promotion Dataset"
    • eventsarray 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"]    }  ]}