/schemas/v3/media-buy/get-media-buy-delivery-request.json
Response Schema: /schemas/v3/media-buy/get-media-buy-delivery-response.json
Request Parameters
Date Range Behavior: The date range is start-inclusive, end-exclusive. For example,Date Range Examples:start_date: "2026-01-01"andend_date: "2026-01-02"returns delivery data for January 1st only (from2026-01-01 00:00:00up to, but not including,2026-01-02 00:00:00). To get a full week of data (Jan 1-7), useend_date: "2026-01-08".
*Either
media_buy_ids or buyer_refs can be provided. If neither provided, returns all media buys in current session context.
Response
Returns delivery report with aggregated totals and per-media-buy breakdowns:Media Buy Delivery Object
See schema for complete field list.
Common Scenarios
Single Media Buy
Multiple Media Buys
Date Range Reporting
Multi-Status Query
Buyer Reference Query
Account-Scoped Query
Metrics Definitions
Query Behavior
Context-Based Queries
- If neither
media_buy_idsnorbuyer_refsprovided, returns all media buys from current session context - Context established by previous operations (e.g.,
create_media_buy)
Status Filtering
- Defaults to
["active"]if not specified - Can be single string (
"active") or array (["active", "paused"]) - Valid filter values are media-buy lifecycle statuses:
pending_activation,active,paused,completed reporting_delayedandfailedare delivery/reporting statuses returned in webhook contexts, not request filter values- Some legacy integrations may emit
pending; treat it as equivalent topending_activation
Date Ranges
- If dates not specified, returns campaign lifetime delivery data
- Both
start_dateandend_datemust be provided together — partial date ranges are invalid - Date format:
YYYY-MM-DD - Start-inclusive, end-exclusive:
start_dateis included,end_dateis excluded. For example,start_date: "2026-01-01"andend_date: "2026-01-02"returns data for January 1st only. - Products declare date range support in
reporting_capabilities.date_range_support - Products with
date_range_support: "lifetime_only"reject requests that includestart_date/end_datewith aDATE_RANGE_NOT_SUPPORTEDerror - Products with
date_range_support: "date_range"accept date parameters and filter delivery data accordingly - Daily breakdown may be truncated for long date ranges to reduce response size
Metric Availability
- Universal: Impressions, spend (available on all platforms)
- Format-dependent: Clicks, video completions (depends on inventory type and platform capabilities)
- Commerce attribution: Conversions, conversion_value, roas, new_to_brand_rate (available on commerce media platforms)
- Attribution window:
attribution_windowdescribes the lookback windows and model used for conversion attribution (e.g., 14-day click, 1-day view, last_touch) - Package-level: All metrics broken down by package with pacing_index
Data Freshness
- Reporting data typically has 2-4 hour delay
- Real-time impression counts not available
- Use for periodic reporting and optimization decisions, not live monitoring
Error Handling
Package-Level Metrics
Theby_package array provides per-package delivery details with these key fields:
Buyer Control:
paused: Whether the package is currently paused by the buyer (true/false)
delivery_status: System-reported operational state:delivering- Package is actively delivering impressionscompleted- Package finished successfullybudget_exhausted- Package ran out of budgetflight_ended- Package reached its end dategoal_met- Package achieved its impression/conversion goal
pacing_index: Delivery pace (1.0 = on track, below 1.0 = behind, above 1.0 = ahead)rate: Effective pricing rate (e.g., CPM)pricing_model: How the package is billed (cpm, cpcv, cpp, etc.)
paused reflects buyer control, while delivery_status reflects system reality. A package can be not paused but have delivery_status: "budget_exhausted".
Creative-Level Metrics
When the seller supports creative-level reporting (supports_creative_breakdown in reporting capabilities), each package includes a by_creative array with per-creative delivery metrics.
Each creative entry includes:
creative_id: Creative identifier matching the creative assignmentweight: Delivery weight for this creative during the reporting period (0-100)- All standard delivery metrics (impressions, spend, clicks, ctr, etc.)
get_creative_delivery. This is a Creative Protocol task — call it on any agent that implements the Creative Protocol, which may be the same sales agent if it declares "creative" in supported_protocols. See Creative capabilities on sales agents.
Catalog-item reporting
For catalog-driven packages (packages with acatalog field), the seller can return per-catalog-item delivery in the by_catalog_item array within each package.
Each entry identifies the catalog item and includes standard delivery metrics:
This is optional. Sellers that support item-level reporting populate
by_catalog_item; sellers that do not simply omit it.
Dimension Breakdowns
When you includereporting_dimensions in the request, the response includes dimensional breakdown arrays within each by_package entry. Each breakdown entry inherits all fields from delivery-metrics plus dimension-specific identifiers.
Requesting breakdowns
test=false
limit (max rows; defaults to 25 for geo, audience, and placement) and sort_by (any value from the sort-metric enum, e.g., spend, impressions, clicks, roas — defaults to spend descending; falls back to spend if the seller does not report the requested metric). Geo requires geo_level (country, region, metro, postal_area) and system for metro/postal levels. Each request uses a single geo_level — for multiple granularities (e.g., country and region), make separate requests. Unsupported dimensions are silently omitted from the response, but malformed requests (e.g., geo without geo_level) return a validation error. Breakdowns are per-dimension only — cross-dimensional intersections (e.g., device_type × geo) are not supported.
Available dimensions
Check
reporting_capabilities on the product to discover which dimensions are available. Product-level capabilities are authoritative since different products from the same seller may support different breakdowns.
Truncation
Each breakdown array has a sibling boolean flag (e.g.,by_geo_truncated). When true, additional rows exist beyond the returned set. When false, the list is complete. Sellers MUST return the truncated flag whenever the corresponding breakdown array is present. Rows are sorted by the requested sort_by metric descending.
Audience sources
Theaudience_source field indicates where the audience segment originated:
Best Practices
1. Check Date Range Support Before requesting date-filtered delivery, checkreporting_capabilities.date_range_support on the product. Products with lifetime_only support reject date range requests — omit start_date and end_date to get campaign lifetime data instead.
2. Use Date Ranges for Analysis
For products that support date ranges, specify dates for period-over-period comparisons and trend analysis.
3. Monitor Pacing Index
Aim for 0.95-1.05 pacing index. Values outside this range indicate delivery issues.
4. Check Daily Breakdown
Identify delivery patterns and weekend/weekday performance differences.
5. Compare Package Performance
Use by_package breakdowns to identify best-performing inventory. Check both paused state and delivery_status to understand why packages aren’t delivering.
6. Track Status Changes
Use multi-status queries to understand why campaigns were paused or completed.
Next Steps
After retrieving delivery data:- Optimize Campaigns: Use
update_media_buyto adjust budgets, pacing, or targeting - Provide Feedback: Use
provide_performance_feedbackto share results with seller - Update Creatives: Use
sync_creativesto refresh underperforming assets - Create Follow-Up Campaigns: Use
create_media_buybased on insights
Learn More
- Media Buy Lifecycle - Complete campaign workflow
- Async Operations - Async patterns and status handling
- Performance Optimization - Using delivery data for optimization