latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Audiences

View

Get information about an audience.

get/audiences/view

Query parameters

namestring required

The name of the existing audience you want to view.

indexing_tokenstring

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

Headers

X-Batch-Projectstring required

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

Response

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

namestring
display_namestring
type'CUSTOM_ID'
nb_idsinteger
indexing_state'APPLIED' | 'IN_PROGRESS' | 'REPLACED'
createdstring

UTC Date in a RFC 3339 format.

updatedstring

UTC Date in a RFC 3339 format.