---
title: "Get the rules execution history"
method: GET
path: "/v2/user/analytics/{storeId}/rules/executions"
tags: ["Analytics - Rules"]
---

# Get the rules execution history

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

## Path parameters

- `storeId` string, guid, required

## Query parameters

- `pageNumber` integer, required
- `pageSize` integer, required

## Response `200`

Rules executions list

- RuleExecutionReportings
  - `executions` RuleExecutionReporting[] — The rules executions history
    - `ruleId` string, guid, required — The rule identifier
    - `ruleName` string, required — The name of the rule
    - `startedUtcDate` string, date-time — The start utc date of the execution of the rule
    - `completedUtcDate` string, date-time — The completed utc date of the execution of the rule
    - `status` 'InProgress' | 'Succeeded' | 'AlreadyInProgress' | 'Aborted' | 'Failed' | 'Unknown', required — The status of the execution of the rule
    - `errorType` 'ChannelNotPresent' | 'StoreIsInSystemBlockState' — The error type for this execution if any
    - `affectedProductCount` integer — The count of affected products, active or not
    - `activeAffectedProductCount` integer — The count of affected active products
    - `affectedChannelCount` integer — The count of affected Channels across all products
    - `optimisationActionName` 'reenable' | 'disable' — The optimisation action
    - `userId` string, guid — The userId that executed the rule if any
    - `executionSource` 'Scheduler' | 'User', required — The requestor type for the execution of the rule
    - `reportUrl` string — The url for the excel report for this execution
    - `links` RuleExecutionReportingLinks — Links to retrieve/action on this rule execution
      - `rule` LinksGetRuleLink
        - `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
  - `paginationResult` BeezUPCommonPaginationResult
    - `entryCount` integer, required — The entry count currently returned
    - `pageCount` integer, required — The page count
    - `totalEntryCount` integer, required — The total entry count
    - `links` BeezUPCommonPaginationResultLinks, required — The navigation links 'first', 'last', 'next', 'previous'
      - `first` BeezUPCommonLink3, 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
      - `last` BeezUPCommonLink3, 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
      - `previous` BeezUPCommonLink3
        - `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
      - `next` BeezUPCommonLink3
        - `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

## Other responses

- `400` — Invalid request
- `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)