Skip to main content
GET
Get Engine Performance

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Query Parameters

hours
integer | null

Hours of history (alternative to date range)

Required range: 1 <= x <= 720
start_date
string<date-time> | null

Start date for time range

end_date
string<date-time> | null

End date for time range

group_by
string
default:hour

Time grouping (minute, hour, day, week)

Pattern: ^(minute|hour|day|week|month)$

Response

Successful Response

Response for engine performance query.

time_range
TimeRange · object
required

Time range of the query

metrics
PerformanceMetric · object[]
required

Time-series performance metrics

summary
PerformanceSummary · object | null

Overall summary statistics