Réponse exemple
GET/v1/quotas/throughputÉchantillons de débit par minute pour l'espace de travail authentifié.Cet endpoint renvoie les échantillons de débit (throughput) collectés pour votre espace de travail, ordonnés du plus ancien au plus récent. Chaque entrée correspond à un point de mesure horodaté, ce qui permet de tracer la consommation de l'API minute par minute et de surveiller les pics de trafic. La fenêtre d'observation est contrôlée par le paramètre minutes : par défaut, l'endpoint remonte les 60 dernières minutes. Comportement notable : il s'agit d'une fonctionnalité dépendante du plan. Si les échantillons ne sont pas disponibles (table inaccessible ou fonctionnalité désactivée sur votre offre), l'endpoint répond malgré tout avec un statut 200 et une liste vide accompagnée d'un champ note explicatif, plutôt qu'une erreur.
Authentification
L'appel exige une clé API valide portant le scope quotas:read. Par alias, les scopes plus larges workspace:billing, workspace:manage et workspace:read satisfont également cette exigence (lire la consommation est considéré comme une lecture de l'espace de travail). Le scope wildcard * et le scope ressource quotas:* sont aussi acceptés. Une session dashboard authentifiée bénéficie d'un accès complet (scopes *). Toutes les données sont automatiquement restreintes à l'espace de travail résolu depuis le contexte d'authentification (workspace_id).
Paramètres de requête
| Champ | Type | Requis | Description |
|---|---|---|---|
| minutes | integer | Non | Taille de la fenêtre d'observation en minutes, comptée à rebours depuis l'instant présent. Valeur par défaut : 60. Bornée entre 1 et 1440 (24 h) : toute valeur hors plage est ramenée dans cet intervalle, et une valeur non numérique retombe sur 60. |
Réponse
La réponse est un objet de type liste. Le champ object vaut toujours list. Le champ data contient le tableau des échantillons de débit, ordonnés par created_at croissant ; chaque échantillon est rattaché à votre workspace_id et porte son horodatage de collecte. Le champ window_minutes reflète la fenêtre effectivement appliquée (après bornage), et le champ since indique l'instant ISO 8601 à partir duquel les échantillons ont été remontés. Lorsque la fonctionnalité n'est pas disponible, data est un tableau vide et un champ note est ajouté à la place de window_minutes/since.
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| 401 missing_api_key | Aucun en-tête Authorization ni session valide. | Fournir Authorization: Bearer cof_live_... ou cof_mcp_live_.... |
| 401 invalid_api_key | Préfixe de clé non reconnu ou clé introuvable. | Vérifier la clé et son préfixe (cof_live_, cof_test_, cof_rk_*, cof_mcp_*). |
| 401 revoked_api_key | Clé révoquée ou inactive. | Régénérer une clé sur https://app.coffrify.com/developer. |
| 401 expired_api_key | Clé expirée. | Émettre une nouvelle clé non expirée. |
| 403 scope_missing | Le token ne porte pas quotas:read ni un scope alias acceptable. | Émettre une clé avec le scope quotas:read (ou workspace:read/workspace:billing/workspace:manage). |
| 403 ip_not_allowed | IP appelante hors de la liste autorisée de la clé. | Appeler depuis une IP autorisée ou ajuster l'allowlist de la clé. |
| 429 rate_limited | Quota de requêtes par minute dépassé, ou nombre max d'utilisations de la clé atteint. | Respecter l'en-tête Retry-After et réduire la cadence. |
| 500 internal_error | Erreur interne (par ex. configuration service indisponible). | Réessayer ; persister le request_id retourné pour le support. |
Voir aussi
GET /v1/quotas— état courant des quotas et de la consommation de l'espace de travail.GET /v1/usage— agrégats de consommation facturable sur la période en cours.- Rate limits de l'API — https://docs.coffrify.com/api/rate-limits