Skip to main content
GET
Get endpoint analytics

Authorizations

Authorization
string
header
default:default
required

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

Path Parameters

projectId
string
required

Project identifier.

id
string
required

Endpoint identifier.

Query Parameters

deploymentId
string

Restrict to a single deployment under this endpoint.

startTime
string<date-time>

Inclusive start of the time range. Defaults to 24 hours ago if unset.

endTime
string<date-time>

Exclusive end of the time range. Defaults to now if unset.

includeTimeSeries
boolean

When true, include per-bucket time series in the response.

granularity
string

Time-series bucket duration, such as 1m, 1h, or 1d. Defaults to 1d.

Response

OK

Endpoint-wide usage and performance analytics with optional time-series and per-deployment breakdowns.

endpointId
string

ID of the endpoint summarized by these analytics.

timeRange
object

Closed-open time range covered by the analytics.

metrics
object

Aggregated metrics over the time range.

timeSeries
object[]

Per-bucket metric samples, included only when includeTimeSeries is true.

deploymentAnalytics
object[]

Per-deployment analytics.