Aller au contenu

Utilisation des messages GET ​

Consultez l'utilisation de messages du jour par rapport à la limite quotidienne de votre offre.

Point de terminaison ​

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

Authentification ​

Obligatoire

Incluez l'un de ces en-têtes dans votre requête :

  • Token: <your-api-key> — Obtenez-la depuis Clés API
  • Authorization: Bearer <jwt-token> — Depuis Connexion

Requête ​

Exemple de requête ​

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();

Réponse ​

Réponse de succès ​

200 OK

Renvoie l'utilisation du jour. Le jour correspond au jour UTC.

ChampTypeDescription
usedintegerMessages acceptés aujourd'hui
limitinteger | nullMessages autorisés par jour, null pour les offres illimitées
unlimitedbooleantrue lorsque l'offre n'a pas de limite quotidienne
rejectedintegerRequêtes refusées aujourd'hui parce que la limite était atteinte
resets_atstringProchaine réinitialisation, 00:00 UTC, au format RFC3339
json
{
  "used": 42,
  "limit": 50,
  "unlimited": false,
  "rejected": 0,
  "resets_at": "2026-09-22T00:00:00Z"
}

Sur une offre illimitée :

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

Réponses d'erreur ​

StatutDescription
401Non autorisé — Jeton invalide ou manquant

Cas d’usage

Comparez used à limit avant une rafale d'alertes, ou affichez le quota restant dans votre propre tableau de bord. Les mêmes valeurs sont renvoyées dans chaque réponse de Créer un message sous forme d'en-têtes X-PA-Daily-*.

Documentation de Pocket Alert