Analytics

Return a time-bucketed series of request volume, error rate, and latency percentiles for a project's API traffic.

Bucket granularity is auto-selected based on the requested window: ≤6 h → 5 min, ≤24 h → 1 h, ≤72 h → 6 h, else → 1 day.

get/projects/{project_id}/api-analytics/timeseries

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/api-analytics/timeseries
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Query parameters

environment_idinteger

Environment ID (optional)

start_datestring required

Window start (ISO 8601)

end_datestring required

Window end (ISO 8601)

Response

Time-series of request volume, errors, and latency

bucket_intervalstring required

Bucket interval used for time series (e.g. "1 hour", "6 hours", "1 day").

overall_avg_latency_msnumber double nullable

Overall mean response time in milliseconds over the full period.

overall_error_ratenumber double required

Overall error rate over the full period (0.0–1.0).

total_errorsinteger required

Aggregate error count (status >= 400) over the full period.

total_requestsinteger required

Aggregate request count over the full period.

Changes

No recorded changes to this operation across all 53 revisions of this API.