Sign in
Analytics

Return the top routes (by request count) in a project's API traffic, grouped by raw `(method, path)`.

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

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/routes
  • 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)

limitinteger

Max routes to return (default: 20, max: 100)

offsetinteger

Ranked routes to skip (default: 0)

Response

Top routes by request count

total_routesinteger required

Total distinct (method, path) pairs in the period (before the limit).

Changes

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