Revenue per campaign
GET/api/v1/revenue
The workspace's campaigns with the paid orders that came from them, newest campaign first.
An order counts towards the campaign in its campaign_id (qn_cid from the link the customer clicked). Amounts are summed per currency. since and until apply to the order's time (processed_at).
Scope
ecommerce:readRead e-commerce – the person behind the key must be all members.
Query parameters
sincestring- Only orders from that time onwards (ISO 8601).
untilstring- Only orders before that time (ISO 8601).
campaign_idstring- Only the campaign.
store_idstring- Only the store's orders.
Response
200 The campaigns with revenue (at most 500).
dataarray<object>requireddata[].campaign_idstringrequireddata[].campaign_namestringrequireddata[].started_atstring (time, ISO 8601) | nullrequired- When the campaign started sending.
data[].ordersintegerrequired- Paid orders from the campaign.
data[].revenuearray<object>required- Revenue per currency.
data[].revenue[].currencystringrequireddata[].revenue[].amountnumberrequireddata[].revenue[].ordersintegerrequired
Errors
- 429
- rate_limited