Skip to main content
GET
Get average latency time series grouped by provider

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

period
enum<string>
required

Reporting window. Rolling windows end now; last_month and last_year are the previous calendar month or year; custom uses start_date and end_date. The response's previous_period is the equally long window immediately before it.

Available options:
last_24_hours,
last_7_days,
last_30_days,
last_month,
last_year,
custom
start_date
string

Start of a custom window, as an ISO 8601 date-time. Required when period is custom and must be before end_date; ignored for other periods.

end_date
string

End of a custom window, as an ISO 8601 date-time. Required when period is custom; ignored for other periods.

interval
enum<string>

Bucket size for data points. Each period allows only some intervals (last_24_hours hourly; last_7_days hourly or daily; last_30_days hourly, daily, or weekly; last_month daily or weekly; last_year weekly or monthly; custom any). An interval the period does not allow falls back to the period's default, reported in period.interval.

Available options:
hourly,
daily,
weekly,
monthly
filters[status][]
string[]

Filter by payment status

filters[currency_code][]
string[]

Filter by currency codes

filters[payment_action][]
string[]

Filter by payment actions

filters[type]
enum<string>

Filter by payment type

Available options:
test,
live

Response

Success

providers
object[]
period
object
previous_period
object
meta
object