API de AnalyticsEndpoints

Retorna o uso atual da cota da API para a empresa autenticada

Retorna o uso e os limites atuais da cota da empresa — uma entrada por janela de cota, como por minuto ou por dia. Todas as API keys da empresa compartilham essa cota. Use este endpoint para se auto-limitar antes de disparar requisições analíticas pesadas. Observações: - Quando uma métrica não tem limite, a resposta usa `limit: null` e `remaining: null` para você não dividir por zero. - Quando a empresa não tem cota, `quotas` é uma lista vazia. - Uma única chamada à API pode contar como mais de uma query contra `max_queries_per_minute`, então o contador `queries` pode subir mais rápido que a sua taxa real de requisições. A resposta inclui `queries.note` para sinalizar isso quando há um limite ativo. O `read_bytes` reflete o volume de dados efetivamente lido e é o sinal mais confiável para dimensionar o seu uso. - O próprio endpoint conta como 1 query contra `max_queries_per_minute`.

GET
/quota/usage

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Acesse a aplicação e copie seu token de API, em seguida, defina o cabeçalho X-Api-Token com ele.

In: header

X-Api-Version<token>

A versão da API a ser usada. As versões suportadas atualmente são:

  • v1: A versão estável atual

Uma requisição sem este cabeçalho, ou com qualquer outro valor, é respondida pela borda com 404 e {"error_msg":"404 Route Not Found"}.

In: header

User-Agent<token>

É obrigatório enviar um User-Agent não vazio identificando sua integração. Requisições sem ele são rejeitadas na borda antes de chegar à API.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/quota/usage"
{  "quotas": [    {      "interval_seconds": 60,      "interval_starts_at": "2026-04-27T12:34:00Z",      "interval_ends_at": "2026-04-27T12:35:00Z",      "queries": {        "used": 20,        "limit": 60,        "remaining": 40,        "note": "a single API request may count as more than one query against this limit"      },      "read_bytes": {        "used": 92535478,        "limit": null,        "remaining": null      }    },    {      "interval_seconds": 86400,      "interval_starts_at": "2026-04-27T00:00:00Z",      "interval_ends_at": "2026-04-28T00:00:00Z",      "queries": {        "used": 245,        "limit": null,        "remaining": null      },      "read_bytes": {        "used": 4500000000,        "limit": 343597383680,        "remaining": 339097383680      }    }  ]}