Skip to main content

Aggregated API usage for the authenticated user.

GET 
/usage

Returns request volumes, error rates and response times over a recent window, broken down by day, by endpoint and by API key. It answers the questions the audit log in the Wheelhouse app answers, without having to read it request by request: which endpoint dominates your traffic, whether a key is being throttled, when errors started.

Covers every RM API key on the account, not just the one making the request. Pass token_id to narrow it to a single key.

The window is limited to 7 days. Pass days_back for a rolling window ending now, or start_time and end_time for an explicit one — a window longer than 7 days returns 400. A window with more requests than can be read in one call sets window.truncated to true and reports the shorter window actually measured, with the most recent requests always covered.

Results are cached for a few minutes. generated_at reports when the figures were computed, which is not the same as when they were served: repeat calls inside the cache window return the same numbers. Polling faster than that gains nothing. If what you want is your live rate limit headroom, read the X-RateLimit-* headers on any response instead — they are current as of that request and cost nothing extra.

Requests are grouped by the endpoint that served them rather than by the exact path called, so every GET /listings/{listing_id}/notes counts towards one entry no matter which listing it named.

Request​

Responses​

Usage figures for the window.