Analytics - Global
Get the Analytics API operation index for one store
get/v2/user/analytics/{storeId}
Path parameters
storeIdstring guid required
Your store identifier
Response
Analytics API operation index for one store
Example response
{
"links": {
"self": {
"href": "/v2/user/analytics",
"method": "GET"
},
"trackingStatus": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/tracking/status",
"method": "GET"
},
"trackedClicks": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/tracking/clicks",
"method": "GET"
},
"trackedOrders": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/tracking/orders",
"method": "GET"
},
"trackedExternalOrders": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/tracking/externalorders",
"method": "GET"
},
"reportByDay": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/reports/byday",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "reportByDayRequest"
}
}
},
"reportByChannel": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/reports/bychannel",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "reportByChannelRequest"
}
}
},
"reportByCategory": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/reports/bycategory",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "reportByCategoryRequest"
}
}
},
"reportByProduct": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/reports/byproduct",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "reportByProductRequest"
}
}
},
"optimiseAll": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/all/enable",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "optimiseAllRequest",
"value": {
"channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
"beginPeriodUtcDate": "2006-11-20T00:00:00Z",
"endPeriodUtcDate": "2006-12-20T00:00:00Z",
"categoryFilter": {
"categoryPath": [
"Home",
"Bedroom"
]
},
"performanceIndicatorFilters": [
{
"performanceIndicator": "Cost",
"operatorName": "Equals",
"value": "10"
}
],
"advancedFilters": {
"marginType": "Global",
"globalmarginPercent": "10",
"linkClickToOrderType": "OnClickDate",
"linkClickToOrderMaxDay": "5",
"onlyPaymentValidatedOrders": "true",
"onlyDirectSales": "true",
"performanceIndicatorFormula": {
"firstParameter": "Cost",
"operatorName": "Multiply",
"secondParamter": "ROI",
"thirdParameter": "100"
}
},
"productState": "All",
"analyticsProductColumnFilters": {
"sku": "M1234",
"title": "Refrigérateur",
"additionalAnalyticsProductColumnFilters": [
{
"columnId": "672644c7-5bd0-4e25-88c1-1f732bda5e4c",
"operatorName": "NumericalGreaterThan",
"values": [
"100"
]
}
]
}
}
}
}
},
"optimise": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/enable",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "optimiseRequest",
"value": {
"channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
"beginPeriodUtcDate": "2006-11-20T00:00:00Z",
"endPeriodUtcDate": "2006-12-20T00:00:00Z",
"categoryFilter": {
"categoryPath": [
"Home",
"Bedroom"
]
},
"performanceIndicatorFilters": [
{
"performanceIndicator": "Cost",
"operatorName": "Equals",
"value": "10"
}
],
"advancedFilters": {
"marginType": "Global",
"globalmarginPercent": "10",
"linkClickToOrderType": "OnClickDate",
"linkClickToOrderMaxDay": "5",
"onlyPaymentValidatedOrders": "true",
"onlyDirectSales": "true",
"performanceIndicatorFormula": {
"firstParameter": "Cost",
"operatorName": "Multiply",
"secondParamter": "ROI",
"thirdParameter": "100"
}
},
"pageSize": "100",
"pageNumber": "1",
"productState": "All",
"analyticsProductColumnFilters": {
"sku": "M1234",
"title": "Refrigérateur",
"additionalAnalyticsProductColumnFilters": [
{
"columnId": "672644c7-5bd0-4e25-88c1-1f732bda5e4c",
"operatorName": "NumericalGreaterThan",
"values": [
"100"
]
}
]
}
}
}
}
},
"optimiseByChannel": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/byChannel/a2d38563-50f0-43f1-be2b-b16e7ec4f007/enable",
"method": "POST"
},
"optimiseByCategory": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/byCategory/4c376178-25b4-4656-a86e-e3bd3a25b139/enable",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "array",
"value": [
"a2d38563-50f0-43f1-be2b-b16e7ec4f007"
]
}
}
},
"optimiseByProduct": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/optimisations/byProduct/6d469a54-8426-4855-abc2-9e062e2056b9/enable",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "array",
"value": [
"a2d38563-50f0-43f1-be2b-b16e7ec4f007"
]
}
}
},
"reportFilters": {
"href": "/v2/user/analytics/8f95eb1a-3691-4750-950d-a13c4a8a9bcc/reports/filters",
"method": "GET"
},
"rules": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules",
"method": "GET"
}
}
}