Get media buy status

​

Request

curl https://api.interchange.io/api/v2/buyer/campaigns/cmp_987654321/media-buy-status \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​

Parameters

​

Response

{
  "campaign_id": "cmp_987654321",
  "campaign_status": "ACTIVE",
  "operational_status": "active",
  "media_buys": [
    {
      "media_buy_id": "mb_abc123",
      "adcp_media_buy_id": "adcp_mb_001",
      "internal_status": "ACTIVE",
      "adcp_status": "active",
      "operational_status": "active",
      "previous_internal_status": "PENDING_APPROVAL",
      "previous_adcp_status": "pending_start",
      "updated": true,
      "status_refresh_source": "direct_agent",
      "blockers": []
    }
  ],
  "agents_queried": 1,
  "errors": [],
  "blockers": [],
  "pending_creative_reviews": 0,
  "has_upstream_media_buy": true,
  "has_delivery": true
}

• campaign_status — the stored campaign lifecycle status.
• operational_status — the rolled-up delivery status to present to users (draft, pending_creatives, pending_start, active, paused, completed, attention_required, or no_media_buys).
• internal_status — the Interchange status after this poll (one of DRAFT, PENDING_APPROVAL, INPUT_REQUIRED, ACTIVE, PAUSED, COMPLETED, CANCELED, FAILED, REJECTED, ARCHIVED).
• adcp_status — the raw AdCP media-buy status string currently stored or returned by the status check.
• media_buys[].operational_status — the per-buy delivery status behind the campaign rollup.
• previous_internal_status / previous_adcp_status — values before this poll.
• updated — true only when this request changed Interchange’s stored status. false does not mean the status is stale; it can also mean the buy was already current.
• status_refresh_source — where this media buy’s status signal came from:
  • direct_agent — this request called the sales agent’s get_media_buys.
  • delegated_adapter — this request called the delegated adapter’s get_media_buys.
  • storefront_route_rollup — this request read persisted upstream-leg statuses for a storefront-routed buy. This can confirm active delivery without incrementing agents_queried.
  • not_submitted — the buy has no upstream media-buy ID yet.
  • refresh_failed — the refresh failed before a per-buy status signal was available; see errors and blockers.
• agents_queried — number of direct sales-agent or delegated-adapter status calls made during this request. It can be 0 for a current storefront-routed buy when status_refresh_source is storefront_route_rollup.
• errors — per-media-buy errors from agents that failed to respond; media_buy_id and error message are included for each failure. A partial error does not prevent successful entries from being returned.
• blockers / media_buys[].blockers — campaign-level and per-buy reasons delivery is not ready, such as pending creative review or missing upstream IDs.
• pending_creative_reviews — count of creative reviews still waiting.
• has_upstream_media_buy — whether any media buy has an upstream ADCP media-buy ID.
• has_delivery — whether the campaign currently has an active delivery signal.

​

Errors

​

Related