curl --request GET \
--url https://omnicommerce.sg/api/v1/analytics/ai-traffic \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/analytics/ai-traffic', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/analytics/ai-traffic"
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>",
"source": "<string>",
"trafficType": "<string>",
"route": "<string>",
"country": "<string>",
"timeZone": "<string>"
},
"filterOptions": {
"sources": [
{
"value": "<string>",
"label": "<string>"
}
],
"routes": [
{
"value": "<string>",
"label": "<string>"
}
],
"countries": [
{
"value": "<string>",
"label": "<string>"
}
]
},
"summary": {
"totalEvents": 0,
"totalHits": 0,
"pageViews": 0,
"productPageViews": 0,
"productsViewed": 0,
"referredSessions": 0,
"indexingHits": 0,
"assistantHits": 0,
"clickThroughs": 0,
"productsRequested": 0,
"productsWithReferrals": 0,
"attributableHits": 0,
"uniqueSources": 0,
"uniqueRoutes": 0,
"uniqueProducts": 0,
"topSource": "<string>",
"topRoute": "<string>",
"topCountry": "<string>",
"lastSeenAt": "<string>"
},
"trend": [
{
"date": "<string>",
"label": "<string>",
"hits": 0,
"attributableHits": 0,
"uniqueSources": 0
}
],
"sourceBreakdown": [
{
"value": "<string>",
"label": "<string>",
"count": 0
}
],
"routeBreakdown": [
{
"value": "<string>",
"label": "<string>",
"count": 0
}
],
"countryBreakdown": [
{
"value": "<string>",
"label": "<string>",
"count": 0
}
],
"productBreakdown": [
{
"productId": "<string>",
"productName": "<string>",
"count": 0
}
],
"recentEvents": [
{
"id": "<string>",
"occurredAt": "<string>",
"sourceLabel": "<string>",
"trafficType": "<string>",
"operator": "<string>",
"routeLabel": "<string>",
"path": "<string>",
"countryCode": "<string>",
"referrer": "<string>",
"inferredKeyword": "<string>",
"inferredIntent": {
"label": "<string>",
"source": "<string>",
"confidence": 123
},
"productId": "<string>",
"productName": "<string>"
}
],
"dataFreshness": {
"metricsAvailable": true,
"notes": [
"<string>"
]
}
},
"jobId": "<string>",
"productId": "<string>"
}Get AI Traffic Analytics
Visits and crawls from AI assistants and search engines: totals, a daily trend, breakdowns by source, route, country, and product, and recent events. Matches the AI Traffic page. Requires analytics:read.
A range covers at most 365 days; a longer one is shortened to the last 365 days. Read the applied range from data.filters.
curl --request GET \
--url https://omnicommerce.sg/api/v1/analytics/ai-traffic \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/analytics/ai-traffic', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/analytics/ai-traffic"
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>",
"source": "<string>",
"trafficType": "<string>",
"route": "<string>",
"country": "<string>",
"timeZone": "<string>"
},
"filterOptions": {
"sources": [
{
"value": "<string>",
"label": "<string>"
}
],
"routes": [
{
"value": "<string>",
"label": "<string>"
}
],
"countries": [
{
"value": "<string>",
"label": "<string>"
}
]
},
"summary": {
"totalEvents": 0,
"totalHits": 0,
"pageViews": 0,
"productPageViews": 0,
"productsViewed": 0,
"referredSessions": 0,
"indexingHits": 0,
"assistantHits": 0,
"clickThroughs": 0,
"productsRequested": 0,
"productsWithReferrals": 0,
"attributableHits": 0,
"uniqueSources": 0,
"uniqueRoutes": 0,
"uniqueProducts": 0,
"topSource": "<string>",
"topRoute": "<string>",
"topCountry": "<string>",
"lastSeenAt": "<string>"
},
"trend": [
{
"date": "<string>",
"label": "<string>",
"hits": 0,
"attributableHits": 0,
"uniqueSources": 0
}
],
"sourceBreakdown": [
{
"value": "<string>",
"label": "<string>",
"count": 0
}
],
"routeBreakdown": [
{
"value": "<string>",
"label": "<string>",
"count": 0
}
],
"countryBreakdown": [
{
"value": "<string>",
"label": "<string>",
"count": 0
}
],
"productBreakdown": [
{
"productId": "<string>",
"productName": "<string>",
"count": 0
}
],
"recentEvents": [
{
"id": "<string>",
"occurredAt": "<string>",
"sourceLabel": "<string>",
"trafficType": "<string>",
"operator": "<string>",
"routeLabel": "<string>",
"path": "<string>",
"countryCode": "<string>",
"referrer": "<string>",
"inferredKeyword": "<string>",
"inferredIntent": {
"label": "<string>",
"source": "<string>",
"confidence": 123
},
"productId": "<string>",
"productName": "<string>"
}
],
"dataFreshness": {
"metricsAvailable": true,
"notes": [
"<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.
80One AI source id from data.filterOptions.sources.
120indexing, click_through, page_view, assistant One route key from data.filterOptions.routes.
120ISO country code of the visit.
8Response
Get AI Traffic Analytics
"developer_v1"accepted, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes