curl --request GET \
--url https://omnicommerce.sg/api/v1/analytics/stores \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/analytics/stores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/analytics/stores"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"filters": {
"from": "<string>",
"to": "<string>",
"marketplace": "<string>",
"country": "<string>",
"store": "<string>",
"currency": "<string>",
"timeZone": "<string>"
},
"hasData": true,
"totals": {
"visitors": 123,
"pageViews": 123,
"newVisitors": 123,
"returningVisitors": 123,
"newFollowers": 123,
"averagePageViews": 123,
"averageStaySeconds": 123,
"placedBuyers": 123,
"placedUnits": 123,
"placedOrders": 123,
"placedSales": 123,
"paidBuyers": 123,
"paidUnits": 123,
"paidOrders": 123,
"paidSales": 123,
"confirmedBuyers": 123,
"confirmedUnits": 123,
"confirmedOrders": 123,
"confirmedSales": 123,
"bounceRate": 123,
"visitorToPlacedRate": 123,
"visitorToPaidRate": 123,
"visitorToConfirmedRate": 123,
"placedToPaidRate": 123,
"placedToConfirmedRate": 123
},
"trend": [
{
"date": "<string>",
"visitors": 123,
"pageViews": 123,
"paidOrders": 123,
"paidSales": 123
}
],
"deviceBreakdown": [
{
"device": "app",
"visitors": 123,
"pageViews": 123,
"newVisitors": 123,
"returningVisitors": 123,
"bounceRate": 123
}
],
"coverage": {
"platforms": [
"<string>"
],
"sources": [
"<string>"
],
"firstDate": "<string>",
"lastDate": "<string>"
}
},
"jobId": "<string>",
"productId": "<string>"
}Get Store Analytics
Seller Centre shop metrics: visitors, page views, followers, the placed, paid, and confirmed buyer funnel, a daily trend, and the app and web split. Matches the Analytics (Seller Centre) page. Requires analytics:read.
Amounts are in data.filters.currency. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
curl --request GET \
--url https://omnicommerce.sg/api/v1/analytics/stores \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/analytics/stores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/analytics/stores"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"filters": {
"from": "<string>",
"to": "<string>",
"marketplace": "<string>",
"country": "<string>",
"store": "<string>",
"currency": "<string>",
"timeZone": "<string>"
},
"hasData": true,
"totals": {
"visitors": 123,
"pageViews": 123,
"newVisitors": 123,
"returningVisitors": 123,
"newFollowers": 123,
"averagePageViews": 123,
"averageStaySeconds": 123,
"placedBuyers": 123,
"placedUnits": 123,
"placedOrders": 123,
"placedSales": 123,
"paidBuyers": 123,
"paidUnits": 123,
"paidOrders": 123,
"paidSales": 123,
"confirmedBuyers": 123,
"confirmedUnits": 123,
"confirmedOrders": 123,
"confirmedSales": 123,
"bounceRate": 123,
"visitorToPlacedRate": 123,
"visitorToPaidRate": 123,
"visitorToConfirmedRate": 123,
"placedToPaidRate": 123,
"placedToConfirmedRate": 123
},
"trend": [
{
"date": "<string>",
"visitors": 123,
"pageViews": 123,
"paidOrders": 123,
"paidSales": 123
}
],
"deviceBreakdown": [
{
"device": "app",
"visitors": 123,
"pageViews": 123,
"newVisitors": 123,
"returningVisitors": 123,
"bounceRate": 123
}
],
"coverage": {
"platforms": [
"<string>"
],
"sources": [
"<string>"
],
"firstDate": "<string>",
"lastDate": "<string>"
}
},
"jobId": "<string>",
"productId": "<string>"
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Query Parameters
Required for session auth. API keys already belong to one organization.
160First day of the range (YYYY-MM-DD). Defaults to 29 days before to.
^\d{4}-\d{2}-\d{2}$Last day of the range, inclusive (YYYY-MM-DD). Defaults to today.
^\d{4}-\d{2}-\d{2}$IANA time zone that defines each day, for example Asia/Kuala_Lumpur. Defaults to Asia/Singapore.
80Comma-separated marketplaces, for example shopee,lazada.
200Comma-separated countries. One country selects its currency.
200Comma-separated store (account) ids from GET /api/v1/marketplaces/connected.
1000ISO currency. Only orders in this currency are counted; amounts are not converted. Defaults to the single country's currency, otherwise SGD.
3Response
Get Store Analytics
"developer_v1"accepted, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes