Skip to main content
GET
/
esa
/
{esaId}
/
media-buys
/
{mediaBuyId}
Get upstream ESA media buy
curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/esa/{esaId}/media-buys/{mediaBuyId} \
  --header 'Authorization: Bearer <token>'
{
  "mediaBuyId": "<string>",
  "principalId": "<string>",
  "principalName": "<string>",
  "status": "<string>",
  "flightStartDate": "<string>",
  "flightEndDate": "<string>",
  "totalBudget": 123,
  "currency": "<string>",
  "createdAt": "<string>",
  "products": [
    "<string>"
  ],
  "creatives": [
    "<string>"
  ],
  "statusHistory": [
    {
      "occurredAt": "<string>",
      "status": "<string>",
      "note": "<string>"
    }
  ],
  "buyerRef": "<string>",
  "deliveredImpressions": 0,
  "deliveredSpend": 123,
  "pacing": "<string>",
  "targeting": {}
}

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

esaId
integer
required

Embedded sales agent connection id.

Required range: x <= 9007199254740991
Example:

123

mediaBuyId
string
required

Upstream embedded sales agent media buy id.

Minimum string length: 1
Example:

"adcp_mb_123"

Response

Get upstream ESA media buy

mediaBuyId
string
required
principalId
string
required
principalName
string
required
status
string
required
flightStartDate
string
required
flightEndDate
string
required
totalBudget
required
currency
string
required
createdAt
string
required
products
string[]
required
creatives
string[]
required
statusHistory
object[]
required
buyerRef
string | null
deliveredImpressions
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
deliveredSpend
pacing
string | null
targeting
object