Get plan suggestion set
curl --request GET \
--url https://api.interchange.io/api/v2/buyer/plan-suggestion-sets/{planSuggestionSetId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/plan-suggestion-sets/{planSuggestionSetId}"
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/plan-suggestion-sets/{planSuggestionSetId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"planSuggestionSetId": "<string>",
"optimizerRunId": "<string>",
"planId": "<string>",
"planName": "<string>",
"campaignId": "<string>",
"campaignName": "<string>",
"planRunSequence": "<string>",
"planMediaBuyCount": 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": {}
}
}Optimization Suggestions
Get plan suggestion set
Get one plan suggestion set, including every media buy it moves budget between and each one’s net movement.
GET
/
plan-suggestion-sets
/
{planSuggestionSetId}
Get plan suggestion set
curl --request GET \
--url https://api.interchange.io/api/v2/buyer/plan-suggestion-sets/{planSuggestionSetId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/plan-suggestion-sets/{planSuggestionSetId}"
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/plan-suggestion-sets/{planSuggestionSetId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"planSuggestionSetId": "<string>",
"optimizerRunId": "<string>",
"planId": "<string>",
"planName": "<string>",
"campaignId": "<string>",
"campaignName": "<string>",
"planRunSequence": "<string>",
"planMediaBuyCount": 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
Plan suggestion set id. Digits only, up to 18 characters — the underlying bigint id.
Pattern:
^[1-9][0-9]{0,17}$Response
Get plan suggestion set
Monotonic per-plan run counter. A pending set is replaced only by a complete set with a strictly greater sequence.
Available options:
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