Authorizations
- Authorization string required header
Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.
Query Parameters
- customer_filters string
Optional JSON-encoded array of customer-level filters applied before calculating the report. See Customer Filters Reference. Cannot be combined with
segment. Example: [{"field":"billing_address_country","operator":"eq","value":"US"}] - end_date string required
End date in the store timezone using YYYY-MM-DD format. Example: 2026-03-31
- segment integer
Optional saved store-wide customer segment ID. You can find the ID on the customer segments page. Example: 123
- source_type string required
Comma-separated UTM fields to group by. Allowed: utm_campaign, utm_medium, utm_source, utm_term, utm_content, utm_id. Example: utm_source,utm_campaign
- start_date string required
Start date in the store timezone using YYYY-MM-DD format. Example: 2026-03-01
Headers
- Accept string required
Response format header. Example: application/json
Response
application/json- meta object
+ - Show Child Attributes
- report_link string
- data[] object array
+ - Show Child Attributes
- utm_source string
- utm_campaign string
- count integer
- returning_customers_count integer
- returning_customers_rate number
- total_order_count integer
- average_order_count number
- total_order_gross integer
- average_customer_ltv number