Campaigns

Search for Campaigns

This method allows the calling application to retrieve Campaigns.

get/campaigns

Request

  • Base URL
    https://resources.uk.eagleeye.com
  • URL
    https://resources.uk.eagleeye.com/campaigns
  • Auth
    none declared. Required headers: X-EES-AUTH-CLIENT-ID, X-EES-AUTH-HASH

Query parameters

campaignId[]string[]

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

referencestring

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

barcodestring

The value of a barcode.

campaignTypestring

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

status'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'PENDING' | 'DRAFT' | 'REJECTED' | 'READY' | 'STOPPED' | 'DELETED'

This is a status of the Campaign.

accountClientTypestring

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

endDatestring date-time
Example:yyyy-mm-dd+hh:mm:ss

When the campaign ends.

startDatestring date-time
Example:yyyy-mm-dd+hh:mm:ss

When the campaign starts.

tag[]string[]

This is a tag assigned to a Campaign.

offsetinteger

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

limitinteger

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

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

Result of Campaigns.

limitinteger

Results per page.

totalinteger

Total Results.

offsetinteger

Offset.

Changes

No recorded changes to this operation across all 1 revision of this API.