v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Audiences

Search for Audience (BETA)

This method allows the calling application to search for Audiences on the AIR platform.

get/audiences

Query parameters

referencestring string
Example:AudienceRef123

This optional request parameter allows the calling application to request Audiences that have a specific reference.

limitinteger
Example:50

The maximum number of Audiences to be returned in the result set.

offsetinteger
Example:51

Offset allows you to skip a number of items before returning data.

orderBy'name,ASC' | 'name,DESC' string

This optional request parameter allows the calling application to request a specific sorting order for a result set.

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

Response

The response of a successful Audiences request.