Skip to main content
GET
/
optimization-suggestions
/
{suggestionId}
Get optimization suggestion
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/optimization-suggestions/{suggestionId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.interchange.io/api/v2/buyer/optimization-suggestions/{suggestionId}"

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/optimization-suggestions/{suggestionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "suggestionId": "<string>",
  "optimizerRunId": "<string>",
  "campaignId": "<string>",
  "mediaBuyId": "<string>",
  "suggestionTimestamp": "<string>",
  "modelVersion": "<string>",
  "optimizationMetric": "<string>",
  "mediaBuyScalingFactor": 123,
  "mediaBuyScalingRationale": "<string>",
  "pacingRecommendation": {
    "errorRatio": 123,
    "currentDailyRate": 123,
    "recommendedDailySpend": 123,
    "message": "<string>"
  },
  "status": "<string>",
  "statusReason": "<string>",
  "statusError": "<string>",
  "createdAt": "<string>",
  "statusUpdatedAt": "<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

Authorization
string
header
required

API key or access token

Path Parameters

suggestionId
string<uuid>
required

Optimization suggestion id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Get optimization suggestion

suggestionId
string
required
optimizerRunId
string | null
required
campaignId
string
required
mediaBuyId
string
required
suggestionTimestamp
string | null
required
modelVersion
string | null
required
optimizationMetric
string | null
required
mediaBuyScalingFactor
number | null
required
mediaBuyScalingRationale
string | null
required
pacingRecommendation
object | null
required

Advisory pacing signal from the optimizer. Null on suggestions produced before the field existed, or when the optimizer had no pacing recommendation to make.

status
string
required
statusReason
string | null
required
statusError
string | null
required
createdAt
string
required
statusUpdatedAt
string
required
{key}
any