/
Retrieve an AML checks re...

Retrieve an AML checks report
Experimental

Request

Retrieves an AML checks report.

Security
SecretApiKey or JWT
Query
periodStartstring, (date-time)

Date and time when the report starts. If not provided or null, the report starts from the first day of the current month.

periodEndstring, (date-time)

Date and time when the report ends. If not provided or null, the report ends at the last day of the current month.

metricstring

Metric on which the report is based.

Default:"aml_checks"
Enum:"aml_checks""aml_check_hits"
includePropagatedResultsboolean

Specifies if propagated AML checks are included.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/aml-checks?periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&metric=aml_checks&includePropagatedResults=true&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Bodyapplication/json
totalinteger

Total number of checks.

propagatedinteger

Total number of propagated checks.

resultedinteger

Total number of resulted checks.

pendinginteger

Total number of pending checks.

Response
{
  "total": 0,
  "propagated": 0,
  "resulted": 0,
  "pending": 0
}