curl --request GET \
--url https://omnicommerce.sg/api/v1/analytics/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/analytics/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/analytics/overview"
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>"
},
"previousFrom": "<string>",
"previousTo": "<string>",
"marketplaceScope": "<string>",
"kpis": {
"grossSales": 123,
"grossSalesChangePercent": 123,
"netSales": 123,
"netSalesChangePercent": 123,
"orders": 0,
"ordersChangePercent": 123,
"unitsSold": 123,
"unitsChangePercent": 123,
"aov": 123,
"aovChangePercent": 123,
"unitsPerOrder": 123,
"unitsPerOrderChangePercent": 123,
"visitors": 123,
"pageviews": 123,
"atcUsers": 123,
"viewToOrderCvr": 123,
"contributionProfit": 123,
"adsSpend": 123
},
"dailyTrend": [
{
"date": "<string>",
"grossSales": 123,
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"aov": 123,
"unitsPerOrder": 123,
"visitors": 123,
"pageviews": 123
}
],
"funnel": [
{
"id": "<string>",
"label": "<string>",
"value": 123,
"covered": true
}
],
"channelMix": [
{
"platform": "<string>",
"accountId": "<string>",
"label": "<string>",
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"changePercent": 123
}
],
"topProducts": [
{
"productId": "<string>",
"variantId": "<string>",
"sku": "<string>",
"productName": "<string>",
"thumbnailUrl": "<string>",
"platform": "<string>",
"accountId": "<string>",
"externalProductId": "<string>",
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"revenueShare": 123,
"gmvChangePercent": 123
}
],
"laggingProducts": [
{
"productId": "<string>",
"variantId": "<string>",
"sku": "<string>",
"productName": "<string>",
"thumbnailUrl": "<string>",
"platform": "<string>",
"accountId": "<string>",
"externalProductId": "<string>",
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"revenueShare": 123,
"gmvChangePercent": 123
}
],
"insights": [
{
"id": "<string>",
"code": "<string>",
"severity": "info",
"category": "conversion",
"title": "<string>",
"summary": "<string>",
"impactLabel": "<string>",
"impactScore": 123,
"productId": "<string>",
"productName": "<string>"
}
],
"coverage": {
"sales": true,
"traffic": true,
"ads": true,
"content": true,
"inventory": true,
"profit": true,
"market": true
},
"syncFreshness": [
{
"jobType": "<string>",
"platform": "<string>",
"accountId": "<string>",
"status": "<string>",
"completedAt": "<string>",
"rowsUpserted": 0
}
]
},
"jobId": "<string>",
"productId": "<string>"
}Get Growth Overview
Sales, traffic, and profit KPIs with their change against the previous period, a daily trend, the traffic funnel, sales by channel, top and lagging products, and ranked next actions. Matches the Growth Intelligence overview 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/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/analytics/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/analytics/overview"
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>"
},
"previousFrom": "<string>",
"previousTo": "<string>",
"marketplaceScope": "<string>",
"kpis": {
"grossSales": 123,
"grossSalesChangePercent": 123,
"netSales": 123,
"netSalesChangePercent": 123,
"orders": 0,
"ordersChangePercent": 123,
"unitsSold": 123,
"unitsChangePercent": 123,
"aov": 123,
"aovChangePercent": 123,
"unitsPerOrder": 123,
"unitsPerOrderChangePercent": 123,
"visitors": 123,
"pageviews": 123,
"atcUsers": 123,
"viewToOrderCvr": 123,
"contributionProfit": 123,
"adsSpend": 123
},
"dailyTrend": [
{
"date": "<string>",
"grossSales": 123,
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"aov": 123,
"unitsPerOrder": 123,
"visitors": 123,
"pageviews": 123
}
],
"funnel": [
{
"id": "<string>",
"label": "<string>",
"value": 123,
"covered": true
}
],
"channelMix": [
{
"platform": "<string>",
"accountId": "<string>",
"label": "<string>",
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"changePercent": 123
}
],
"topProducts": [
{
"productId": "<string>",
"variantId": "<string>",
"sku": "<string>",
"productName": "<string>",
"thumbnailUrl": "<string>",
"platform": "<string>",
"accountId": "<string>",
"externalProductId": "<string>",
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"revenueShare": 123,
"gmvChangePercent": 123
}
],
"laggingProducts": [
{
"productId": "<string>",
"variantId": "<string>",
"sku": "<string>",
"productName": "<string>",
"thumbnailUrl": "<string>",
"platform": "<string>",
"accountId": "<string>",
"externalProductId": "<string>",
"netSales": 123,
"orders": 0,
"unitsSold": 123,
"revenueShare": 123,
"gmvChangePercent": 123
}
],
"insights": [
{
"id": "<string>",
"code": "<string>",
"severity": "info",
"category": "conversion",
"title": "<string>",
"summary": "<string>",
"impactLabel": "<string>",
"impactScore": 123,
"productId": "<string>",
"productName": "<string>"
}
],
"coverage": {
"sales": true,
"traffic": true,
"ads": true,
"content": true,
"inventory": true,
"profit": true,
"market": true
},
"syncFreshness": [
{
"jobType": "<string>",
"platform": "<string>",
"accountId": "<string>",
"status": "<string>",
"completedAt": "<string>",
"rowsUpserted": 0
}
]
},
"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 Growth Overview
"developer_v1"accepted, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes