curl --request GET \
--url https://api.interchange.io/api/v2/buyer/campaign-suggestion-sets/{campaignSuggestionSetId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/campaign-suggestion-sets/{campaignSuggestionSetId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/campaign-suggestion-sets/{campaignSuggestionSetId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"campaignSuggestionSetId": "<string>",
"optimizerRunId": "<string>",
"campaignId": "cmp_987654321",
"campaignDbId": "4471",
"campaignName": "<string>",
"campaignRunSequence": "<string>",
"campaignMediaBuyCount": 123,
"budgetCurrency": "<string>",
"applyMode": "AUTO",
"status": "<string>",
"statusReason": "<string>",
"netAllocationDelta": "<string>",
"applyAttemptCount": 123,
"compensationAttemptCount": 123,
"notifiedAt": "<string>",
"decidedAt": "<string>",
"appliedAt": "<string>",
"firstMessageAt": "<string>",
"lastMessageAt": "<string>",
"mediaBuys": [
{
"suggestionId": "<string>",
"adcpMediaBuyId": "<string>",
"mediaBuyName": "<string>",
"netAllocationDelta": "<string>",
"appliedAt": "<string>"
}
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Get campaign suggestion set
Get one campaign suggestion set, including every media buy it moves budget between and each one’s net movement.
curl --request GET \
--url https://api.interchange.io/api/v2/buyer/campaign-suggestion-sets/{campaignSuggestionSetId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/campaign-suggestion-sets/{campaignSuggestionSetId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/campaign-suggestion-sets/{campaignSuggestionSetId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"campaignSuggestionSetId": "<string>",
"optimizerRunId": "<string>",
"campaignId": "cmp_987654321",
"campaignDbId": "4471",
"campaignName": "<string>",
"campaignRunSequence": "<string>",
"campaignMediaBuyCount": 123,
"budgetCurrency": "<string>",
"applyMode": "AUTO",
"status": "<string>",
"statusReason": "<string>",
"netAllocationDelta": "<string>",
"applyAttemptCount": 123,
"compensationAttemptCount": 123,
"notifiedAt": "<string>",
"decidedAt": "<string>",
"appliedAt": "<string>",
"firstMessageAt": "<string>",
"lastMessageAt": "<string>",
"mediaBuys": [
{
"suggestionId": "<string>",
"adcpMediaBuyId": "<string>",
"mediaBuyName": "<string>",
"netAllocationDelta": "<string>",
"appliedAt": "<string>"
}
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Campaign suggestion set id. Digits only, up to 18 characters — the underlying bigint id.
^[1-9][0-9]{0,17}$Response
Get campaign suggestion set
The campaign's business identifier, as GET /campaigns returns it and GET /campaigns/{campaignId} takes it.
"cmp_987654321"
The campaign's internal row id. Matches campaignDbId on the optimization-suggestion notifications.
"4471"
Monotonic per-campaign run counter. A pending set is replaced only by a complete set with a strictly greater sequence.
AUTO, MANUAL Sum of every member media buy's net movement, in minor units. Exactly "0" for any set that is eligible to apply.
When the buyer was notified this set is waiting on them. Null means the set is actionable but no notification has landed yet.
Show child attributes
Show child attributes