View

See create to see an introduction about Audience API.

API Description

View

get

Get information about an audience.

Authorizations

Query parameters

namestringrequired

The name of the existing audience you want to view.

indexing_tokenstringoptional

The indexing token returned by the create, replace, update or remove routes.

Header parameters

X-Batch-Projectstringrequired

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

Example: project_0664hxvwffvbpn278gxdyhsadddqgna6

Responses

application/json

objectoptional

application/json

application/json

application/json

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /2.4/audiences/view HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Accept: */*

{
  "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"
}

Request structure

Route

The Audience API exposes a GET endpoint that allows to get information about a audience :

https://api.batch.com/2.4/audiences/view

Headers and authentication

See Overview → Using Project APIs.

Query parameters

See the API Description.

Responses

Success

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

{
  "name": "string",
  "display_name": "MBE123",
  "type": "CUSTOM_ID",
  "nb_ids": 2,
  "indexing_state": "APPLIED",
  "created": "2023-10-03T09:35:08Z",
  "updated": "2023-10-03T09:35:08Z"
}

The indexing state is the indexing state of the update that returned the given indexing token. If there is no indexing token provided, the state of the last update will be used. 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.

Failure

If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at [email protected] if you need further support.

See the list of potential failures in the API Description.