Conventions

Request ids

Every response carries X-Request-Id. Log it, and quote it when you contact support.

Every response from the API, success or error, carries a request id:

HTTP/1.1 200 OK
X-Request-Id: 4f6c1d2e-8a3b-4c5d-9e0f-1a2b3c4d5e6f

The same id is in the body of every error, as error.requestId. Gauge's own logs are keyed on it, so with the id support can find your exact request in seconds; without it, they are searching by time.

Log it next to your own record of the call, at least for errors.

Bring your own id

If you already trace requests with your own id, send it as X-Request-Id and Gauge uses it instead of minting one, end to end. It must be a UUID or a ULID; anything else is ignored and Gauge mints a fresh UUID.

curl https://app.gauge.chat/backend/v2/me \
  -H "Authorization: Bearer $GAUGE_API_KEY" \
  -H "X-Request-Id: 01JAXQ7M3R9K5V2T8N4P6W1Y0Z"

Find a request in the console

Developers → Logs lists every /v2 request for the last 14 days: method, route, status, latency, the key that made it, and whether it was an idempotent replay. Paste a request id into the search to jump to it.

On this page