v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Audiences

Create Audience (BETA)

This method allows the calling application to create an Audience on the AIR platform.

post/audiences

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.

Request body

idstring

The ID of the Audience automatically generated and unique within Eagle Eye AIR.

namestring required

The name of the Audience.

referencestring required

The reference of the Audience.

dateCreatedstring date-time

The date-time when the Audience was added to the AIR platform.

lastUpdatedstring date-time

The date-time when the Audience was last updated on in the AIR platform.

startDatestring date-time nullable

The start date of the Audience.

endDatestring date-time nullable

The end date of the Audience.

Response

The response of a successful Audiences request.