/campaign/{id}/impressions

get

https://devpartners.actv8technologies.com/campaign/{id}/impressions

Gets campaign impressions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Campaign id for which the impressions need to be obtained

Query Params

start_at

string

required

Start date for the impressions (i.e. 2018-01-01)

end_at

string

required

End date for the impressions (i.e. 2018-01-15)

limit

integer

The number of documents that should be included in the results.

skip

integer

The number of documents that should be skip in the query. If not set, results will start from the beginning (based on start_date)

trigger_type

string

If provided, the results are filterd for the specific trigger type (e.g. audio, geofence, media, etc.)

aggregated_by

string

enum

Specifies the field for the aggregation. If not specified, results are returned as raw data.

Allowed:

interval

string

enum

Specifies the desired interval for the aggregation. Defaults to '1d' (1 day)

country_code

string

Specifies the country code (i.e. 'US' instead of 'United States') to filter the aggregations by. Required when 'aggregated_by' is set to 'state'

state

string

Specifies the name of the country state (use abbreviated form when country_code = 'US') to filter the aggregations by. Required when 'aggregated_by' is set to 'city'

subaggregation

boolean

Specifies if subaggregations must be included in the response. This is only available when aggregating by 'state'

Responses

200

Response contains impressions data for a given campaign

204

No content

400

When requesting raw impressions the results cannot exceed 1000

401

Unauthorized

403

Forbidden