v1
latestOpenAPI 3.0.02026-07-2466275257.1 KBRetrieve campaign history
Retrieve a campaign's history using its campaign ID. You can access the entire campaign history or specify a date range by using the fromDate and toDate parameters.
Query parameters
The ID of the campaign for which history is being requested.
The unique identifier for a retailer-managed team. As a retailer, you can retrieve history for the supplier team by specifying the retailerTeamId. Ensure that API requests are authenticated with the retailer's bearer token.
Pagination token to retrieve the next page of results. If not provided, the first page will be returned.
Specifies the number of campaigns to retrieve per page. Only positive integers up to 1,000 are allowed. If a value greater than 1,000 is provided, an error will be returned.
Specifies the start timestamp for retrieving campaign history. Provide the time in ISO-8601 format. If you specify fromDate, you must also specify toDate.
Specifies the end timestamp for retrieving campaign history. Provide the time in ISO-8601 format. If you specify toDate, you must also specify fromDate.
Sorting the history
Response
A list of campaign history records and a pagination token.
Example response
{
"campaignHistory": [
{
"campaignPayload": {
"id": "abc123xyz",
"updateTime": "2024-09-01T12:34:56Z",
"name": "Summer Sale Campaign",
"namespaceId": "namespace_001",
"templateId": "template_123",
"managerTeamId": "manager_team_67890",
"teamId": "team_12345",
"startTime": "2024-09-01T12:00:00Z",
"endTime": "2024-09-30T23:59:59Z",
"walletId": "wallet_123456789",
"placementId": "placement_987654321",
"catalogIds": [
"catalog_001",
"catalog_002"
],
"advertisedProducts": {
"productsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"targeting": {
"searchTerms": [
{
"phrase": "example search term",
"collectionName": "default_collection",
"suggested": true,
"excludedProducts": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
],
"maxBid": "100.00",
"treatAsCustom": true
}
],
"crossSell": {
"targetProductsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"upsell": {
"targetProductsByKey": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"excludeFilters": [
{
"catalogId": "catalog_12345",
"filter": "filter_value_abc"
}
],
"includeFilters": [
{
"catalogId": "catalog_12345",
"filter": "filter_value_abc"
}
]
},
"strategy": {
"auction": {
"maxBid": "$100.00",
"spendLimit": {
"daily": "$50.00",
"total": "$1000.00"
}
},
"fixedTenancy": {
"cost": "$99.99",
"positions": [
1,
2,
3
],
"catalogCosts": [
{
"catalogId": "catalog_123456",
"catalogCostPercentage": 0.25
}
]
}
},
"fixedCosts": {
"dataCost": "$100.00",
"creativeCost": "$200.00",
"otherCost": "$50.00"
},
"customFields": [
{
"customFieldId": "cfid_12345",
"content": "This is a custom field content."
}
],
"customQuestions": [
{
"customQuestionId": "cqid_67890",
"answers": [
"Answer 1",
"Answer 2",
"Answer 3"
]
}
],
"sellerId": "seller_12345",
"bannerXConfig": {
"contentStandardId": "content_standard_001",
"slotId": "slot_001",
"headingText": "Welcome to our store!",
"bannerText": "Summer Sale: Up to 50% off!",
"bannerTextColourHex": "#FF5733",
"ctaFlag": true,
"ctaText": "Click Here",
"ctaTextAccessibility": "Click to learn more",
"ctaLink": "https://www.example.com",
"backgroundColourHex": "#FFFFFF",
"backgroundImageId": "bg_image_001",
"secondaryBackgroundImageId": "secondary-image-id-123",
"heroImageId": "hero-image-id-456",
"heroImageAltText": "This is the hero image.",
"secondaryHeroImageId": "456defghi",
"secondaryHeroImageAltText": "Secondary hero image description",
"additionalFields": [
{
"id": "12345abcde",
"value": "abcd-8798uhu"
}
],
"trackingTagProvider": [
{
"content": "<script src='tracking.js'></script>"
}
],
"primaryVideoConfig": {
"fileId": "video-id-1234"
},
"companionProducts": [
{
"catalogId": "catalog_001",
"productCode": "PROD123456",
"sellerId": "seller_78910"
}
]
},
"bannerConfig": {
"contentStandardId": "content_standard_001",
"slotsConfiguration": [
{
"slotId": "Category",
"artworkImageId": "ysdcsdcsdcsdc=",
"link": "http://abc.com/",
"altText": null,
"text": null,
"trackingTagProvider": [
{
"content": "<IMG SRC=\"https://example.com\">",
"provider": "TRACKING_TAG_PROVIDER_DCM_IMPRESSION"
}
]
}
]
}
}
}
]
}