Ir para o conteúdo

Uso de mensagens GET ​

Veja o uso de mensagens de hoje em relação ao limite diário do seu plano.

Endpoint ​

GET https://api.pocketalert.app/v1/messages/usage

Autenticação ​

Obrigatório

Inclua um destes cabeçalhos na sua requisição:

  • Token: <your-api-key> — Obtenha em Chaves de API
  • Authorization: Bearer <jwt-token> — Veja em Entrar

Requisição ​

Exemplo de requisição ​

bash
curl -X GET "https://api.pocketalert.app/v1/messages/usage" \
  -H "Token: your-api-key"
javascript
const response = await fetch('https://api.pocketalert.app/v1/messages/usage', {
  headers: { 'Token': 'your-api-key' }
});
const usage = await response.json();
python
import requests

response = requests.get(
    'https://api.pocketalert.app/v1/messages/usage',
    headers={'Token': 'your-api-key'}
)
print(response.json())
php
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/messages/usage');

return $response->json();

Resposta ​

Resposta de sucesso ​

200 OK

Retorna o uso de hoje. O dia considerado é o dia UTC.

CampoTipoDescrição
usedintegerMensagens aceitas hoje
limitinteger | nullMensagens permitidas por dia, null em planos ilimitados
unlimitedbooleantrue quando o plano não tem limite diário
rejectedintegerRequisições recusadas hoje por causa do limite atingido
resets_atstringPróxima reinicialização, 00:00 UTC, em RFC3339
json
{
  "used": 42,
  "limit": 50,
  "unlimited": false,
  "rejected": 0,
  "resets_at": "2026-09-22T00:00:00Z"
}

Em um plano ilimitado:

json
{
  "used": 1280,
  "limit": null,
  "unlimited": true,
  "rejected": 0,
  "resets_at": "2026-09-22T00:00:00Z"
}

Respostas de erro ​

StatusDescrição
401Não autorizado — Token inválido ou ausente

Caso de uso

Compare used com limit antes de um volume grande de alertas, ou mostre a cota restante no seu próprio painel. Os mesmos números voltam em cada resposta de Criar mensagem como cabeçalhos X-PA-Daily-*.

Documentação do Pocket Alert