Reporting Overview
Get historical performance, campaign metadata, and near real-time Display reporting data.
Walmart Connect Reporting APIs help partners retrieve Display campaign data for performance analysis, optimization, reconciliation, and automated reporting.
Use these APIs to access:
- Performance data: Impressions, clicks, spend, sales, orders, new buyer metrics, creative performance, viewability, and other report-specific measures.
- Entity metadata: Campaign and ad group information used to understand advertiser campaign structure, status, and configuration.
- Near real-time delivery data: Current delivery, budget utilization, and pacing signals for operational monitoring.
Reporting APIs support both historical file-based reporting and intraday performance monitoring.
Availability
Availability differs by media solution
- Onsite Display: Stats and Snapshot Reporting support self-serve and managed-serve accounts.
- Offsite Display (Walmart DSP): Report and Entity Snapshots are supported. Available report types and metrics may differ from Onsite Display.
Refer to the Snapshot Reporting guide for report-specific availability.
Choosing the right reporting API
Walmart Connect provides three primary reporting capabilities. Select the appropriate API based on the data you need, how frequently it is updated, and how your platform will use it.
| Capability | Performance Snapshots | Entity Snapshots | Near Real-Time Delivery Performance |
|---|---|---|---|
| Primary purpose | Historical performance reporting | Campaign and ad group metadata | Intraday delivery and pacing monitoring |
| Data returned | Performance and attribution metrics | Entity structure, status, and configuration | Current delivery, spend, and budget metrics |
| Output | CSV file | JSON file | Direct API response |
| Processing | Asynchronous | Asynchronous | Synchronous |
| Freshness | Daily, through T-1 | Based on snapshot generation | Refreshed every 15 minutes |
| Media solutions | Onsite Display and Walmart DSP | Onsite Display and Walmart DSP | Onsite Display |
| Best for | Reporting pipelines, reconciliation, and analysis | Campaign hierarchy sync and metadata joins | Operational dashboards and optimization |
Performance Snapshots
Use Performance Snapshots to generate historical performance reports for an advertiser and selected date range.
Performance reporting data is refreshed once daily and is available through T-1, subject to processing completion. For example, on July 17, the latest available finalized reporting date would typically be July 16.
Performance Snapshots support workflows such as:
- Daily and weekly reporting pipelines
- Campaign, line item, tactic, SKU, creative, and bid-level reporting
- Conversion, sales, and new buyer analysis
- Sales lift, basket analysis, and IVT/viewability reporting
- Historical data exports and reconciliation
Use the Latest Report Date API to confirm the latest processed date before requesting performance reports.
Entity Snapshots
Use Entity Snapshots to retrieve campaign and ad group metadata in JSON format.
Entity Snapshots help partners:
- Build and refresh campaign hierarchy in their platforms
- Map campaign and ad group IDs to names, statuses, and configurations
- Join entity metadata with performance reporting
- Keep downstream reporting systems aligned with campaign structure
Entity Snapshots support campaign and ad group entities, with options to retrieve active, inactive, or all supported entities.
Near Real-Time Delivery Performance
Use the Stats API to monitor current campaign and ad group delivery.
Data is refreshed every 15 minutes, supporting workflows that require more frequent visibility than daily performance reporting.
Common uses include:
- Monitoring current impressions, clicks, spend, and valid bids
- Tracking budget utilization and pacing
- Identifying delivery issues during the day
- Powering operational dashboards and alerts
- Supporting intraday optimization
Near real-time vs. finalized reportingNear real-time delivery data is intended for operational monitoring, not as a replacement for historical performance reporting.
Because Stats data is refreshed more frequently, its values may differ from finalized Snapshot reports.
Recommended integration pattern
For reporting platforms that need both finalized performance data and current delivery visibility, use the following integration pattern.
Build your reporting pipeline
Use scheduled snapshots to retrieve finalized performance data and maintain campaign metadata.
- Check the latest available report date.
- Generate Performance Snapshots for the required period.
- Generate Entity Snapshots to refresh campaign metadata.
- Retrieve completed snapshot file URLs.
- Download, store, and ingest the files.
Monitor active delivery
Use near real-time metrics alongside historical reporting to support operational decisions.
- Request current campaign or ad group delivery metrics.
- Review impressions, clicks, spend, and budget utilization.
- Evaluate pacing and identify delivery issues.
- Use current signals to support optimization workflows.
This approach combines finalized historical reporting with current operational visibility without treating the two data sources as interchangeable.
Reporting endpoints
Use the following APIs to build reporting and monitoring workflows.
| Action | Endpoint | Technical specifications |
|---|---|---|
| Create Performance Snapshot | POST /api/v1/snapshot/report | View |
| Create Entity Snapshot | POST /api/v1/snapshot/entity | View |
| Retrieve Snapshots | GET /api/v1/snapshot | View |
| Near Real-Time Delivery Performance | GET /api/v1/stats | View |
Common issues
- Requesting performance data for dates that have not completed processing
- Treating near real-time delivery data as finalized historical reporting
- Assuming a successful snapshot creation request means the file is ready
- Attempting to download a snapshot before
jobStatus=done - Reading
detailsas an informational message instead of the generated file URL - Downloading a snapshot without the required authentication headers or
advertiserId - Attempting to retrieve a snapshot file after its 24-hour availability window
- Using performance snapshots when campaign or ad group metadata is needed
What happens next
Choose the supporting guide based on your integration requirements.
- Historical performance reporting: Use Snapshot Reports to select report types, metrics, and date ranges.
- Campaign metadata: Use Entity Snapshot to retrieve campaign and ad group configuration.
- Current delivery monitoring: Use Stats API for intraday delivery and pacing metrics.
- Report availability: Use Latest Report Date before scheduling finalized report requests.
Related pages
Updated 4 days ago