Skip to main content

One named limit for one window.

name
string
required

The limit: general covers all requests; reporting covers the reporting and sequence statistics endpoints.

period
string
required

Window length — 1m, 1h or 7d.

baseLimit
integer
required

The standard limit for this window.

limit
integer
required

The limit that applies to you in this window. It can be higher than baseLimit.

used
integer
required

Requests counted in the current window.

remaining
integer
required

Requests left in the current window; never below 0.

Required range: x >= 0
resetsAt
string<date-time> | null
required

UTC time the count resets; null when nothing has been counted in this window yet.