Platform

Retrieve the calling credential's rate limit state

What this credential has left, on every budget that applies to it, measured after this request has been counted.

Three budgets exist. general counts every request. audience counts only the operations that return subscriber or recipient email addresses. write counts only the operations that change something. The two narrow budgets are smaller than general, and the operations they cover are charged to both and have to pass both, so a credential that has exhausted one of them can still call everything else.

Read this rather than inferring the whole picture from the RateLimit-* headers, which describe one budget at a time.

This operation is itself counted against the general budget.

get/rate-limit

Request

  • Base URL: https://api.usecommune.com
  • URL: https://api.usecommune.com/rate-limit
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://usecommune.com/api/oauth/authorize, token URL https://usecommune.com/api/oauth/token)

Response

The current window, limit and remaining for this credential.

object'rate_limit' required

Always rate_limit.

limitinteger required

The general budget's limit, repeated for convenience.

remaininginteger required

Requests left on the general budget in this window.

window_secondsinteger required

The general budget's window length.

reset_atstring date-time required

When the general budget's window resets.

Changes

No recorded changes to this operation across all 1 revision of this API.