Summary
Returns per-endpoint API metrics rows so dashboards can rank slow, high-volume, or error-heavy routes. Metrics include API-key-authenticated Developer API traffic only; dashboard sessions, admin routes, hosted public flows, OAuth callbacks, inbound provider webhooks, health checks, and the metrics endpoints themselves are excluded.
Authorization
AuthorizationBearer <token>In header
Workspace API key.
Query Params
fromOptionalstring
Start timestamp in RFC3339 format. Defaults to 7 days before now.
toOptionalstring
End timestamp in RFC3339 format. Defaults to now. The maximum raw range is 90 days.
methodOptionalstring
Filter by HTTP method.
ValuesGET | POST | PUT | PATCH | DELETE
pathOptionalstring
Filter by normalized endpoint path, such as
/v1/posts/:id/publish.status_classOptionalstring
Filter by HTTP status class.
Values2xx | 3xx | 4xx | 5xx
sortOptionalstring
Summary sort key.
Valuestotal_calls_desc | p95_ms_desc | p99_ms_desc | server_errors_desc | rate_limited_desc
limitOptionalinteger
Maximum rows for list endpoints. Defaults to 50, maximum 200.
Response Body
200
data[]array
Per-endpoint metric rows ordered by the requested sort key.
data[].pathstring
Normalized API route path.
data[].methodstring
HTTP method for the route.
data[].total_callsnumber
Number of matching API requests for the endpoint.
data[].success_countnumber
Responses with status below 400.
data[].client_error_countnumber
Responses from 400 through 499, including 429.
data[].server_error_countnumber
Responses with status 500 or higher.
data[].rate_limited_countnumber
Responses with status 429.
data[].error_rate_pctnumber
All 4xx and 5xx responses divided by total calls.
data[].server_failure_rate_pctnumber
5xx responses divided by total calls.
data[].p50_msnumber
Median endpoint latency in milliseconds.
data[].p95_msnumber
95th percentile endpoint latency in milliseconds.
data[].p99_msnumber
99th percentile endpoint latency in milliseconds.
data[].avg_msnumber
Average endpoint latency in milliseconds.
400
error.codestring
Usually "UNAUTHORIZED", "VALIDATION_ERROR", or "INTERNAL_ERROR".
error.normalized_codestring
Lowercase alias such as "unauthorized" or "validation_error".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
401
error.codestring
Usually "UNAUTHORIZED", "VALIDATION_ERROR", or "INTERNAL_ERROR".
error.normalized_codestring
Lowercase alias such as "unauthorized" or "validation_error".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
500
error.codestring
Usually "UNAUTHORIZED", "VALIDATION_ERROR", or "INTERNAL_ERROR".
error.normalized_codestring
Lowercase alias such as "unauthorized" or "validation_error".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
Related Endpoints
GET/v1/api-metrics/overall for aggregate totals.
GET/v1/api-metrics/summary for per-endpoint latency and error rows.
GET/v1/api-metrics/trend for hourly or daily chart buckets.
GET/v1/api-metrics/status-codes for exact status-code distribution.
Trend error_count uses the same 4xx-plus-5xx definition as error_rate_pct; 429 responses are also exposed separately through rate_limited_count.