GET - View

The Custom Audience API 1.1 only accepts install IDs for the moment. For audiences with custom user IDs or advertising IDs, the version 1.0 should be used.

The Custom Audience API enables you to create, update, delete and list custom audiences. A custom audience can contain a list of custom user IDs, advertising IDs (GAID or IDFA) or install IDs.

This is useful to target segments with push notifications or In-App messages, either they are coming from your userbase or created by third-party tools.

Custom audiences created using the API can be targeted from Batch’s dashboard or the Campaigns API.

NOTE: Custom Audiences with install IDs are only supported from the 1.1 version of the Custom Audience API. Also note that this version doesn't support custom user IDs and advertising IDs for the moment.

Request structure

Route

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

https://api.batch.com/1.1/BATCH_API_KEY/custom-audience

Here is a valid cURL example:

curl -H "Content-Type: application/json" -H "X-Authorization: BATCH_REST_API_KEY" -X GET "https://api.batch.com/1.1/BATCH_API_KEY/custom-audience"

The BATCH_API_KEY value is either your Live, Dev or SDK Batch API key from the settings page of your app within the dashboard (⚙ Settings → General).

Headers

In order to authenticate with the API, you need to provide your company REST API Key as the value of the X-Authorization header. You can find it in ⚙ Settings → General.

Get parameters

Id	Description
`indexing_token`	String - Optional The indexing token returned by the replace and update routes. E.g.`"/custom-audience/audience1?indexing_token=INDEXING_TOKEN"`

Here is an example of a valid cURL CLI request :

curl -H "Content-Type: application/json" -H "X-Authorization: BATCH_REST_API_KEY" -X GET
"https://api.batch.com/1.1/BATCH_API_KEY//custom-audience/audience1?indexing_token=INDEXING_TOKEN"

Responses

Success

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

{
  "name": "audience1",
  "type": "install_ids",
  "description": "The audience1 description",
  "created": "2018-06-29T13:12:09",
  "updated": "2018-06-29T13:42:59",
  "nb_ids": 16743,
  "indexing_state": "IN_PROGRESS" // IN_PROGRESS, APPLIED
}

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.

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.

AUTHENTICATION_INVALID (Http status code: 401, Error code: 10)
API_MISUSE (Http status code: 403, Error code: 12)
ROUTE_NOT_FOUND (Http status code: 404, Error code: 20)
MISSING_PARAMETER (Http status code: 400, Error code: 30)
MALFORMED_PARAMETER (Http status code: 400, Error code: 31)
MALFORMED_JSON_BODY (Http status code: 400, Error code: 32)
SERVER_ERROR (Http status code: 500, Error code: 1)
MAINTENANCE_ERROR (Http status code: 503, Error code: 2)

Documentation > API > Custom Audience API > v1.1 (install ids only)