Skip to content
Sign in Waitlist

Usage summary

GET /v1/usage scope read

API usage of this workspace over the last days (1 to 30, default 7, in UTC): total, successful (< 400), errors, p95 duration, peak requests in one minute against the per-minute limit, byDay, byHour (only with days=1: the last 24 hours) and byKey (session = the dashboard).

HeadersAuthorization: Bearer praeko_… and X-Praeko-Contract: en. Always send both.

Parameters

Name In Description
days query How many days to look back (1 to 30). Default: 7.

Example

curl "https://praeko.app/v1/usage" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en"

Response

Success status When
200 Success.
Response 200
{
  "days": 7,
  "period": {
    "from": "2026-11-01T00:00:00.000Z",
    "to": "2026-11-07T14:02:11.482Z"
  },
  "total": 1842,
  "succeeded": 1790,
  "errors": 52,
  "p95Ms": 180,
  "peakPerMinute": 41,
  "limitPerMinute": 300,
  "byDay": [
    {
      "day": "2026-11-06",
      "total": 312,
      "errors": 4
    },
    {
      "day": "2026-11-07",
      "total": 98,
      "errors": 0
    }
  ],
  "byKey": [
    {
      "id": "01KA3Y1B9E5MK7PR3XD0V4SN2G",
      "name": "script automation",
      "total": 1842,
      "errors": 52,
      "lastAt": "2026-11-07T14:02:11.482Z"
    }
  ]
}

Days in UTC; byDay has one item per day of the period, including days without requests.

Errors

No errors specific to this route besides the common ones.

Errors on any route

Status code When
401 unauthorized The Authorization: Bearer … header is missing.
401 invalid_api_key The key does not exist.
401 revoked_api_key The key has been revoked.
401 expired_api_key The key has expired.
403 forbidden The key's scope is not enough for this route (see the scope badge).
429 rate_limited The per-minute request limit was exceeded.

The body of every error is { "error": { "code", "message", "details"? } }. See all error codes.

Try it

Try it

The live test uses your key and your account. It stays off when you are not signed in.

Sign in to try it
Question or mistake on this page? contato@praeko.appView .md

Type to search pages, routes and error codes.