Skip to main content
GET
Get settlement throughput and funnel metrics

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Query Parameters

environment_slug
string | null

Filter by environment slug (e.g., production, staging)

period
enum<string>
default:24h

Time period: 1h, 24h, 7d, or 30d

Available options:
1h,
24h,
7d,
30d

Response

Successful Response

Throughput and funnel statistics for a given time period.

period
string
required
throughput
MetricsThroughput · object
required

Throughput statistics for the given period.

funnel
MetricsFunnel · object
required

Funnel counts - how many settlements entered each state during the period.