Search for Campaigns

This method allows the calling application to retrieve Campaigns.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
campaignId[]
array of strings

Array of Campaign IDs, automatically generated and unique within Eagle Eye AIR.

campaignId[]
string

An external reference for the Campaign, unique to each client.

string

The value of a barcode.

string

The type of Campaign this is. These types are configured as part of implementation with a client.

string
enum

This is a status of the Campaign.

string

The default client type for an Account unless otherwise stated during individual Account creation.

date-time

When the campaign ends.

date-time

When the campaign starts.

tag[]
array of strings

This is a tag assigned to a Campaign.

tag[]
integer

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

integer

The number of campaigns to return up to a maximum of 100.

Headers
string
required

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

string
required

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

string
enum

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.

Allowed:
string

Unique Reference for the API transaction within the calling company.

string

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

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json