Retrieve a rules matched summary report
Experimental

Request

Retrieves a rules matched summary report that is based on triggered events.
Security
SecretApiKey or JWT
Path
eventTypestring(EventType)read-onlyrequired
Type of system event.
Enum:"account-password-reset-requested""account-verification-requested""aml-list-possibly-matched""application-instance-disabled""application-instance-enabled""balance-transaction-settled""coupon-application-removed""coupon-applied""coupon-expiration-modified""coupon-expired"
Query
periodStartstring, (date-time)
Date and time when the report starts. If not specified, defaults to the first day of the current month.
periodEndstring, (date-time)
Date and time when the report ends. If not specified, defaults to the last day of the current month.
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/events-triggered/{eventType}/rules?periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
dataArray of objects
Matched rule data.
Response
{
  "data": [
    { … }
  ]
}