GET /v1/usage

Retourne votre utilisation actuelle de l'API et les informations de plan.

Cas d'usage : Utilisez cet endpoint pour surveiller votre quota API avant de faire des requêtes en masse, ou pour afficher les informations d'utilisation dans votre propre tableau de bord.

Requête

bash

curl -H "x-api-key: YOUR_KEY" https://api.buska.io/api/v1/usage

Réponse

json

{
      "team": "Acme Corp",
      "plan": "growth",
      "usage": {
        "used": 45,
        "limit": 500,
        "remaining": 455,
        "month": "2026-08",
        "resetsAt": "2026-09-01T00:00:00.000Z"
      },
      "credits": 0,
      "availablePlatforms": ["twitter", "reddit", "linkedin", "youtube"]
    }

Champs de la réponse

Champ	Type	Description
team	string	Nom de votre équipe
plan	string	Plan actuel (starter, growth, scale)
usage.used	number	Requêtes utilisées ce mois-ci
usage.limit	number	Limite mensuelle de requêtes
usage.remaining	number	Requêtes restantes
usage.month	string	Mois de facturation auquel s'appliquent les compteurs (AAAA-MM)
usage.resetsAt	ISO date	Date de remise à zéro du compteur (1er du mois suivant)
credits	number	Crédits à l'usage, consommés une fois le quota mensuel épuisé
availablePlatforms	string[]	Plateformes que votre plan peut interroger

API Buska : référence endpoint GET /v1/usage

GET /v1/usage

Requête

Réponse

Champs de la réponse

Guides connexes