Skip to main content
GET
/
campaigns
/
{campaignId}
/
products
Get campaign products
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/campaigns/{campaignId}/products \
  --header 'Authorization: Bearer <token>'
{
  "campaignId": "<string>",
  "discoveryId": "<string>",
  "products": [
    {
      "productId": "<string>",
      "salesAgentId": "<string>",
      "selectedAt": "<string>",
      "mediaBuys": [
        {
          "mediaBuyId": "<string>",
          "status": "<string>",
          "name": "<string>"
        }
      ],
      "productName": "<string>",
      "salesAgentName": "<string>",
      "publisherDomain": "<string>",
      "publisherName": "<string>",
      "bidPrice": 123,
      "budget": 123,
      "pricingOptionId": "<string>",
      "pricingModel": "<string>",
      "searchContext": {
        "id": "<string>",
        "brief": "<string>"
      }
    }
  ],
  "searchContexts": [
    {
      "id": "<string>",
      "brief": "<string>",
      "channels": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "createdAt": "<string>",
      "productCount": 4503599627370495
    }
  ],
  "summary": {
    "totalProducts": 4503599627370495,
    "productsOnMediaBuys": 4503599627370495,
    "productsPending": 4503599627370495
  }
}

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

id
string
required

Unique identifier for the campaign

Minimum string length: 1
Example:

"cmp_987654321"

Response

Get campaign products

Every product attached to a campaign, sourced from the campaign's media buys (authoritative) plus any discovery-staged products that have not yet been executed onto a media buy. Use this to get the full ad-product list for a campaign without paging through the nested mediaBuys[] tree on get_campaign. Pass mediaBuyId to narrow to a specific buy.

campaignId
string
required

Campaign ID

discoveryId
string | null
required

Discovery session attached to the campaign, or null if none attached

products
object[]
required

Products staged on this campaign

searchContexts
object[]
required

Discovery runs that have contributed products

summary
object
required

Aggregate counts for products on the campaign