Retrieve a rules matched summary report

Retrieves a rules matched summary report that is based on triggered events.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string (EventType)

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" "customer-created" "customer-one-time-password-requested" "dispute-created" "dispute-modified" … 55 more
query Parameters
periodStart
required
string <date-time>

Date and time when the report starts.

periodEnd
required
string <date-time>

Date and time when the report ends.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

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
Response Schema: application/json
Array of objects

Matched rule data.

Array
rule
string

Name of the matched rule.

count
integer

Total number of times this rule is matched.

approvalRate
number <double>

Rate of transaction approval by rule.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/events-triggered/{eventType}/rules
Request samples
const params = {
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getRulesMatchedSummary(params);
Response samples
application/json
{
  • "data": [
    ]
}