Skip to content

Overview metrics

GET
/v1/metrics/overview
from
string format: date-time
to
string format: date-time

Overview metrics

object
from
required
string format: date-time
Example
2026-10-17T09:14:03.218Z
to
required
string format: date-time
Example
2026-10-17T09:14:03.218Z
totals_by_rail
required
Array<object>
object
rail
required
string
payments
required
integer
amount_usd_minor
required
string
attribution_coverage
required
object
events
required
integer
attributed
required
integer
ratio
required
number
verification_coverage
required
object
events
required
integer
with_valid_verification
required
integer
ratio
required
number
screening_coverage
required
object
events
required
integer
screened
required
integer
ratio
required
number
open_alerts
required
object
total
required
integer
by_severity
required
object
key
additional properties
integer
median_time_to_acknowledge_ms
required
integer | null

The request is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

Not signed in, or the API key is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

Not allowed for this role or key

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W