Cloady Docs
API ReferenceEndpointsApplications

Read one route over time

Returns one route's request rate, 5xx rate and duration quantiles at each step of the range. `route` and `method` name the route as readServiceRoutes lists it. `serviceName` is a compose service.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/services/{serviceName}/routes/series
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
serviceName*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string
range?string

How far back to look; the answer has 30 to 96 points across it

Default"1h"

Value in

  • "15m"
  • "1h"
  • "6h"
  • "24h"
  • "7d"
route*string

The route, exactly as the routes listing names it

Length1 <= length <= 400
method?string

The method; every method of the route when absent

Lengthlength <= 16
source?string

Where the numbers come from: ingress reads the access log of the service the app's address routes to, traces reads the OpenTelemetry server spans the service sends. Defaults to ingress for that service and traces for every other one

Value in

  • "ingress"
  • "traces"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/services/string/routes/series?route=string"
{  "start": 0,  "step": 0,  "rps": [    0  ],  "errors": [    0  ],  "p50": [    0  ],  "p95": [    0  ],  "p99": [    0  ]}