EN

Usage

1 endpoint

get/v1/usage

Lire l'usage agrégé de la clé API authentifiée

Retourne les buckets d'agrégation (par heure ou par jour) de la consommation de la clé authentifiée sur une plage temporelle donnée, plus les totals calculés application-side. Utile pour dimensionner sa consommation, monitorer les latences et détecter les rejets rate limit.

Aucun scope spécifique requis (pattern GitHub /rate_limit) : consulter ses propres metrics est gratuit et toujours permis pour toute clé authentifiée.

La plage (to - from) doit être strictement positive et ne pas dépasser 90 jours. Les buckets retournés sont triés par bucket_start ASC ; les fenêtres sans trafic sont absentes du tableau (pas de zéro-padding).

Scopes requis:

Paramètres de requête

NomTypeobligatoireDescription
fromstringobligatoireBorne inférieure (inclusive) de la plage temporelle, ISO 8601 UTC.
tostringobligatoireBorne supérieure (exclusive) de la plage temporelle, ISO 8601 UTC. Doit être strictement après `from` et la plage `(to - from)` ≤ 90 jours.
granularitystringoptionnelGranularité des buckets retournés. `day` par défaut.

Responses

StatusDescription
200

Buckets et totals d'usage pour la plage demandée.

400

La requête est mal formée (header manquant, JSON invalide, paramètre invalide).

401

Clé API inconnue ou format invalide.

429

Le quota de requêtes par fenêtre est dépassé pour cette clé API ou cet endpoint.

500

Erreur serveur inattendue. Toujours fournir le request_id au support.

Exemple de requête

curl -X GET 'https://app.capturia.io/api/v1/usage' \
  -H 'Authorization: Bearer cap_live_<your-key>' \
  -H 'Content-Type: application/json'