Service statusLog in

List

See create to see an introduction about Audience API.

API Description

List

get

List audiences.

Authorizations
AuthorizationstringRequired

API Key Authentication

Authentication is required in order to interact with Batch's APIs.

Batch implements authentication using API Keys, that we call the "REST API Key". You can find it on your dashboard.

Please make sure that you keep this key secret. You should never use it in client apps to call APIs from there as it would easily be extractable.

How to authenticate

In order to authenticate your requests, add your REST API Key in the Authorization header and prefix it by Bearer. Example: Authorization: Bearer bcd38d9rfb38ra28.

Query parameters
fromstringOptional

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_from value returned in a previous response to request subsequent results.

limitinteger · max: 100Optional

A limit on the number of objects to be returned.

Default: 10Example: 20
Header parameters
X-Batch-ProjectstringRequired

The unique project key, identifying a project on the Batch platform

Example: project_0664hxvwffvbpn278gxdyhsadddqgna6
Responses
200

If the GET to the API endpoint is successful you will receive an HTTP 200 confirmation and information about your audiences.

application/json
get
/audiences/list
GET /2.8/audiences/list HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Accept: */*

{
  "audiences": [
    {
      "name": "text",
      "display_name": "text",
      "type": "CUSTOM_ID",
      "nb_ids": 1,
      "indexing_state": "APPLIED",
      "created": "2023-08-12T22:30:05Z",
      "updated": "2023-08-12T22:30:05Z"
    }
  ],
  "count": 4012,
  "has_more": true,
  "next_from": "text"
}

Request structure

Route

The Audience API exposes a GET endpoint that allows to list audiences :

/audiences/list

Headers and authentication

See Overview → Using Project APIs.

Query parameters

See API Description.

Responses

Success

If the GET to the API endpoint is successful you will receive an HTTP 200 confirmation and information about your audiences.

{
  "audiences": [
    {
      "name": "string",
      "display_name": "string",
      "type": "CUSTOM_ID",
      "nb_ids": 0,
      "indexing_state": "APPLIED",
      "created": "2023-08-12T22:30:05Z",
      "updated": "2023-08-12T22:30:05Z"
    }
  ],
  "count": 4012,
  "has_more": true,
  "next_from": "676DEZREZ"
}

3 values are possible for indexing state

  • IN_PROGRESS : update processing is in progress

  • APPLIED : update processing is finished

  • REPLACED : the audience content has been replaced since the issue of the indexing token.

Pagination infos:

  • next_from can be used for the next call to list to retrieve the next page

  • count is only returned for the first page

Failure

If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at support@batch.com if you need further support.

See the list of potential failures in the API Description.

PreviousRemoveNextView

Last updated