Create Entity Snapshot

Note: The POST functionality is similar for both Onsite and Offsite display

📘
URL: POST/api/v1/snapshot/entity

Request Parameters

Parameter	Description	Type	Required	Possible Values
advertiserId	The ID of the advertiser	integer	Y	Unique numeric identifier
entityStatus	The status of the entity	string	Y	Possible values: active, inactive, all Note: if entityStatus = active: For Onsite display: the json snapshot response will have entities with status = LIVE, SCHEDULED For Offsite display: the json snapshot response will have entities with status = ACTIVE if entityStatus = inactive: For Onsite display: the json snapshot response will have entities with status =DRAFT, PAUSED For Offsite display: the json snapshot response will have entities with status =INACTIVE if entityStatus = all: For Onsite display: the json snapshot response will have entities with status = LIVE, SCHEDULED, DRAFT, PAUSED, COMPLETED For Offsite display: the json snapshot response will have entities with status = ACTIVE, INACTIVE, PAUSED, COMPLETED
entityTypes	The type of entity for which the snapshot should be generated.	array	Y	Possible values: campaign, lineItem

Parameter

Description

Type

Required

Possible Values

advertiserId

The ID of the advertiser

integer

Unique numeric identifier

entityStatus

The status of the entity

string

Possible values: active, inactive, all

Note: if entityStatus = active:

For Onsite display: the json snapshot response will have entities with status = LIVE, SCHEDULED
For Offsite display: the json snapshot response will have entities with status = ACTIVE

if entityStatus = inactive:

For Onsite display: the json snapshot response will have entities with status =DRAFT, PAUSED
For Offsite display: the json snapshot response will have entities with status =INACTIVE

if entityStatus = all:

For Onsite display: the json snapshot response will have entities with status = LIVE, SCHEDULED, DRAFT, PAUSED, COMPLETED
For Offsite display: the json snapshot response will have entities with status = ACTIVE, INACTIVE, PAUSED, COMPLETED

entityTypes

The type of entity for which the snapshot should be generated.

array

Possible values: campaign, lineItem

Note:

There is no limit on number of snapshot requests for an advertiser. However, there is a rate limit in place
The snapshot format type is gzip


Header Name	Description	Required	Values
Authorization	The token will provide you the access to the API. It is same for all advertisers you access through the API	Y	Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide. This key can be repurposed for SP API access as well.
WM_CONSUMER.ID	We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.	Y	Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for further explanation on this
WM_SEC.AUTH_SIGNATURE	Auth signature as an API key	Y	Use the signature generator code from Getting Started Guide to generate this value
WM_CONSUMER.intimestamp	Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp	Y	Use the signature generator code (Getting Started Guide) to generate this value
WM_SEC.KEY_VERSION	We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API	Y	1

Element	Description	Type
code	The response code can have following values: success failure	string
details	Details of the error if value of response code is failure	string
snapshotId	ID of the snapshot	string
jobStatus	It is an indicator to confirm status of snapshot generation.The possible values of jobStatus are: `pending`, `processing`, `done`, `failed`, `expired`	string