API referenceReporting
Campaign, live-sales, blog and affiliate conversion reports
AuthorizationBearer <token>
API key from Settings → API keys
In: header
Path Parameters
storeId*string
Query Parameters
from*string
Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timeto*string
Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timeliveMinutes?integer
Range
15 <= value <= 360Default
60Response Body
application/json
application/json
curl -X GET "https://example.com/v1/stores/string/reporting?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"{ "shortSales": { "from": "string", "to": "string", "points": [ { "bucket": "string", "currency": "str", "orders": -9007199254740991, "revenueMinor": -9007199254740991 } ] }, "activityMap": [ { "country": "st", "visitors": -9007199254740991 } ], "blog": [ { "path": "string", "views": -9007199254740991, "visitors": -9007199254740991, "engagedMs": -9007199254740991, "paidOrders": -9007199254740991, "conversionRate": 0 } ], "campaigns": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "sent": -9007199254740991, "opens": -9007199254740991, "clicks": -9007199254740991, "carts": -9007199254740991, "checkouts": -9007199254740991, "paidSessions": -9007199254740991, "attributedOrders": -9007199254740991, "revenueMinor": -9007199254740991, "currency": "str" } ], "affiliates": { "clicks": -9007199254740991, "attributedOrders": -9007199254740991, "paidOrders": -9007199254740991, "skippedOrders": -9007199254740991, "affiliates": [ { "affiliateId": "db499c7c-f1f8-4bce-9ff0-10cc890eeda0", "code": "string", "clicks": -9007199254740991, "attributedOrders": -9007199254740991, "paidOrders": -9007199254740991, "skippedOrders": -9007199254740991, "conversionRate": 0 } ], "products": [ { "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "name": "string", "qty": -9007199254740991, "orders": -9007199254740991 } ] }}