Analytics - Rules
Gets the list of rules for a given store
get/v2/user/analytics/{storeId}/rules
Path parameters
storeIdstring guid required
Your store identifier
Response
Rule list
Example response
{
"rules": [
{
"ruleId": "c38006b4-29d0-4b8a-978b-701a0b12d5a8",
"ruleName": "My Rule",
"lastExecutionStatus": "Succeeded",
"lastExecutionUtcDate": "2016-08-29T09:12:33.001Z",
"actionName": "reenable",
"reportFilterId": "fb19c53c-2f63-4262-9d94-2d7faa500acd",
"validityStartUtcDate": "2016-08-29T09:12:33.001Z",
"validityEndUtcDate": "3016-08-29T09:12:33.001Z",
"links": {
"self": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8",
"method": "GET"
},
"update": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8",
"method": "PATCH",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "updateRuleRequest",
"value": {
"ruleName": "My Rule Renamed",
"startUtcDate": "2016-08-29T09:12:33.001Z",
"endUtcDate\"": "2016-08-29T09:12:33.001Z"
}
}
}
},
"delete": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8",
"method": "DELETE"
},
"moveup": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8/moveup",
"method": "POST"
},
"movedown": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8/movedown",
"method": "POST"
},
"enable": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8/enable",
"method": "POST"
},
"disable": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8/disable",
"method": "POST"
},
"run": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/c38006b4-29d0-4b8a-978b-701a0b12d5a8/run",
"method": "POST"
},
"reportFilter": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/reports/filters/fb19c53c-2f63-4262-9d94-2d7faa500acd",
"method": "GET"
}
}
}
],
"links": {
"self": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules",
"method": "GET"
},
"create": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules",
"method": "POST",
"parameters": {
"request": {
"in": "body",
"type": "object",
"schema": "createRuleRequest",
"value": {
"optimisationActionName": "reenable",
"ruleName": "My rule",
"reportFilterId": "fb19c53c-2f63-4262-9d94-2d7faa500acd",
"startUtcDate": "2016-08-29T09:12:33.001Z",
"endUtcDate": "2017-09-30T10:42:40.001Z"
}
}
}
},
"history": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/executions",
"method": "GET"
},
"run": {
"href": "/v2/user/analytics/10af9486-e28e-47ab-b045-e13e4acd55c3/rules/run",
"method": "POST"
}
}
}