TAtalon
Audiences

List audiences

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Get all audiences created in the account. To create an audience, use Create audience.

get/v1/audiences

Request

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

withTotalResultSizeboolean

When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.

  • When true: totalResultSize contains the total number of results for this query.
  • When false: Only hasMore is returned, and it is set to true when there are more results than shown on the page.

Response

OK

hasMoreboolean
totalResultSizeinteger

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "accountId": 3886,
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "name": "Travel audience",
      "sandbox": true,
      "description": "Travel audience 18-27",
      "subscribedApplicationsIds": [
        3,
        13
      ],
      "integration": "mparticle",
      "integrationId": "382370BKDB946",
      "lastUpdate": "2022-04-26T11:02:38Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.