---
title: "Gets the list of rules for a given store"
method: GET
path: "/v2/user/analytics/{storeId}/rules"
tags: ["Analytics - Rules"]
---

# Gets the list of rules for a given store

`GET /v2/user/analytics/{storeId}/rules`

## Path parameters

- `storeId` string, guid, required

## Response `200`

Rule list

- RuleList
  - `rules` Rule[], required — Rule list
    - `ruleId` string, guid, required — The identifier of the rule
    - `ruleName` string, required — The name of the rule
    - `lastExecutionStatus` 'InProgress' | 'Succeeded' | 'Failed' | 'Unknown' — The status of the last execution
    - `lastExecutionUtcDate` string, date-time — The utc date of the last execution
    - `actionName` 'reenable' | 'disable', required — The optimisation action
    - `reportFilterId` string, guid, required — Report filter identifier linked to the rule
    - `position` integer, required — Rule execution position
    - `enabled` boolean, required — Is the rule enabled
    - `validityStartUtcDate` string, date-time — Rule validity start utc date
    - `validityEndUtcDate` string, date-time — Rule validity end utc date
    - `links` RuleLinks, required — Links to retrieve/action on other entities
      - `self` LinksGetRuleLink, required
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `update` LinksUpdateRuleLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `delete` LinksDeleteRuleLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `moveup` LinksMoveUpRuleLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `movedown` LinksMoveDownRuleLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `enable` LinksEnableRuleLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `disable` LinksDisableRuleLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `run` LinksRunRuleLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `reportFilter` LinksGetReportFilterLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
  - `links` RuleListLinks, required — Links to know if the user can create a rule or run all rules
    - `self` LinksGetRulesLink, required
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
    - `create` LinksCreateRuleLink, required
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
    - `history` LinksGetRulesExecutionsLink, required
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
    - `run` LinksRunRulesLink, required
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string

## Other responses

- `404` — Store or resource not found
- `default` — Occurs when something goes wrong

---

[API](https://skmtc.net/beezup/apis/beezup-merchant-api.md) · [All operations](https://skmtc.net/beezup/apis/beezup-merchant-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beezup/beezup-merchant-api/versions/557b7feddf8a/schema)