GET /experimental/histograms/aml-checks

Retrieves AML check histogram report data.

Servers

Query parameters

Name Type Required Description
metric String No

Metric on which the report is based.

Valid values:

  • "aml_checks_in_review"
  • "aml_check_hits_in_review"
  • "aml_checks"
  • "aml_check_hits_pending_review"
  • "aml_check_hits_false_positive"
  • "aml_check_hits_confirmed_match"
  • "aml_checks_no_match"
  • "aml_check_hits"
  • "aml_checks_confirmed_match"
  • "aml_checks_pending_review"
  • "aml_check_hits_no_match"
  • "aml_checks_false_positive"

Default value: "sales_count"

aggregationPeriod String No

Aggregation period of the report.

Valid values:

  • "month"
  • "day"
  • "minute"
  • "hour"

Default value: "day"

filter String No

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.

periodStart String No

Date and time when the report starts. The default value depends on the aggregation period:

  • 24 hours ago for minute aggregation.
  • First day of the current month for other aggregation periods.
periodEnd String No

Date and time when the report ends. The default value depends on the aggregation period:

  • Current time for minute aggregation.
  • Last day of the current month for other aggregation periods.
includePropagatedResults Boolean No

Specifies if propagated AML checks are included.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.