BEbeezup
Analytics - Rules

Gets the rule

get/v2/user/analytics/{storeId}/rules/{ruleId}

Request

Path parameters

storeIdstring guid required

Your store identifier

ruleIdstring guid required

Your rule identifier

Response

Get Rule

ruleIdstring guid required

The identifier of the rule

ruleNamestring required

The name of the rule

lastExecutionStatus'InProgress' | 'Succeeded' | 'Failed' | 'Unknown'

The status of the last execution

lastExecutionUtcDatestring date-time

The utc date of the last execution

actionName'reenable' | 'disable' required

The optimisation action

reportFilterIdstring guid required

Report filter identifier linked to the rule

positioninteger required

Rule execution position

enabledboolean required

Is the rule enabled

validityStartUtcDatestring date-time

Rule validity start utc date

validityEndUtcDatestring date-time

Rule validity end utc date

Example response

{
  "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"
    }
  }
}

Changes

No recorded changes to this operation across all 9 revisions of this API.