Retrieve a rules matched summary report

Retrieve a rules matched summary report by events triggered.

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

The system event type.

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" … 52 more
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array of objects
Array
rule
string

Rule matched name.

count
integer

Count of matched rule.

approvalRate
number <double>

Transaction approval rate by rule.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/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": [
    ]
}