/rateLimit/usage

24-hour request volume, rate-limit hits, and currently-configured limits for the calling partner system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Partner self-service visibility

Returns a 24-hour rolling summary of API calls made by the calling registered system, plus the currently-configured rate limits. Use this in place of scraping per-response X-RateLimit-... headers when you want a wider view than the most-recent request.

📘

Authentication

Requires valid X-System and X-System-Key request headers.

📘

Cache window

The response is cached server-side for 30 seconds. Frequent polling within that window returns identical data — design your client to poll at most once per minute.

🚧

Limiter attribution not included

This response totals all rate-limited requests but does not break them down by which limiter (global, per-route, per-account) triggered.

Response

The aggregate window is exactly the last 24 hours, bucketed hourly. Per-hour buckets are summed for the totals; peak_hour is the hour with the highest combined (rate-limited + non-rate-limited) request count.

FieldTypeDescription
systemstringThe calling system's registered name.
periodstringAlways last_24h.
usage.total_requestsintAll API calls attributed to this system in the trailing 24h.
usage.rate_limited_requestsintSubset of total_requests rejected by a global rate limiter.
usage.rate_limit_percentagefloat(rate_limited_requests / total_requests) * 100, rounded to two decimals. 0 if there was no traffic.
usage.peak_hourstring|nullISO 8601 hour bucket (YYYY-MM-DDTHH:00:00Z) with the highest call count. null when no traffic.
usage.current_limits.across_all_accountsobjectPer-route global ceilings. default is the catch-all; named keys are per-route overrides.
usage.current_limits.per_accountobjectPer-account ceilings. Same shape as across_all_accounts.

Example response

{
  "system": "your-system",
  "period": "last_24h",
  "usage": {
    "total_requests": 1247,
    "rate_limited_requests": 23,
    "rate_limit_percentage": 1.84,
    "peak_hour": "2026-05-19T14:00:00Z",
    "current_limits": {
      "across_all_accounts": { "default": 750, "GET.people": 100 },
      "per_account": { "default": 25 }
    }
  }
}

Errors

StatusMeaning
401Missing or invalid user API key.
403Only registered systems can call this endpoint.

Related

Headers
string
required

The name of the registered system.

string
required

The key of the registered system.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json