v1
latestOpenAPI 3.0.32026-07-243003151.2 MBSearch for Campaigns
This method allows the calling application to retrieve Campaigns.
Query parameters
Array of Campaign IDs, automatically generated and unique within Eagle Eye AIR.
An external reference for the Campaign, unique to each client.
The value of a barcode.
The type of Campaign this is. These types are configured as part of implementation with a client.
This is a status of the Campaign.
The default client type for an Account unless otherwise stated during individual Account creation.
When the campaign ends.
When the campaign starts.
This is a tag assigned to a Campaign.
Offset allows you to skip a number of campaigns before returning data.
The number of campaigns to return up to a maximum of 100.
Headers
Client ID, This will be provided by EES and is unique to the company calling the API.
Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret
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.
Unique Reference for the API transaction within the calling company.
This flag denotes the number of attempts that have been made for this request.
Response
Result of Campaigns.