For AI agents: a machine-readable documentation index for this API is available at /llms.txt. Every page is also available as Markdown — append ".md" to the URL or send an "Accept: text/markdown" request header.

Triage a spike in failed requests

Find what is behind a jump in errors and read the request that proves it.

When error volume jumps, the hard part is not noticing it, it is finding the one request that explains it. This walks from the shape of the spike down to a single failing exchange you can read end to end.

Reach for this when someone reports that things started breaking and you need to say what broke, where, and for whom, rather than just confirming that something did.

Steps

Restless runs these six in order with your stored key. Nothing here changes data.
  1. 1

    Confirm the identity and access behind the API key with GET /api/v1/me.

  2. 2

    Pick the target project. If you only have an example slug, verify it with GET /api/v1/projects/{slug}, or browse options via GET /api/v1/projects.

  3. 3

    Establish the shape of the spike with GET /api/v1/projects/{slug}/metrics, passing groupBy=status plus since and until to bracket the window the user is asking about.

  4. 4

    Find where the errors are concentrated with GET /api/v1/projects/{slug}/endpoints, passing withErrors=true over the same window. This ranks endpoints by volume and reports their error rates.

  5. 5

    Pull the failing requests themselves with GET /api/v1/projects/{slug}/logs, filtering on status and, once step 4 names an endpoint, urlContains.

  6. 6

    Open one representative failure with GET /api/v1/projects/{slug}/logs/{logId} for the full request and response, then explain the failure from that record rather than from the aggregate.