Skip to main content
GET
Get storefront reporting

Authorizations

Authorization
string
header
required

API key or access token

Query Parameters

inventorySourceId
string

Filter to media buys flowing through a single inventory source (storefront_inventory_source.source_id). When omitted, includes every inventory source on the storefront.

startDate
string

Start date in ISO format (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-01"

endDate
string

End date in ISO format (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-31"

days
integer
default:7

Number of days to include (default: 7, min: 1, max: 90).

Required range: 1 <= x <= 90
Example:

7

view
enum<string>
default:summary

Response format: "summary" for hierarchical advertiser/media-buy/package breakdown, "timeseries" for flat per-day rows.

Available options:
summary,
timeseries
download
boolean
default:false

When true, generates a CSV file and returns a signed download URL instead of JSON data

demo
boolean
default:false

When true, returns auto-generated demo data instead of querying real data sources

Response

Get storefront reporting

Hierarchical storefront reporting response: advertiser → media buy → package

advertisers
object[]
required

Advertiser-level reporting data

totals
object
required

Aggregated totals across all advertisers

periodStart
string
required

Start of the reporting period (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
periodEnd
string
required

End of the reporting period (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$