Consommation du projet
Cette ressource est une synthèse, en un seul appel, de tout ce que le projet contient : l'abonnement sur lequel il court, et le nombre de membres d'équipe, de clés, de fichiers et d'événements qu'il détient. Elle fait pendant à Quota et consommation de tokens, qui indique ce que le projet peut encore dépenser.
Les appels
| Méthode | Chemin | Droit requis |
|---|---|---|
| GET | /v1/usage | usage:read |
Cet appel n'accepte aucun paramètre.
Lire la consommation
curl https://api.think.ultineo.com/v1/usage \
-H "Authorization: Bearer sk-project-YOUR_KEY"{
"code": 200,
"title": "OK",
"response": {
"object": "usage",
"plan": {
"id": "plan_0664fc57b92acb9124be",
"name": "Starter"
},
"counts": {
"team_members": 4,
"api_keys": 3,
"files": 11,
"events": 842
}
}
}L'objet de consommation
| Champ | Type | Description |
|---|---|---|
object | chaîne | Toujours usage. |
plan | objet | L'abonnement sur lequel court le projet, sous id et name, ou null. |
counts | objet | Les totaux du projet. Voir ci-dessous. |
counts
| Champ | Type | Description |
|---|---|---|
team_members | entier | Les membres actuellement rattachés au projet. |
api_keys | entier | Les clés qui authentifient encore. |
files | entier | Les fichiers que détient le projet. |
events | entier | Les entrées du journal d'activité du projet. |
Ce sont des totaux vivants de ce qui existe à l'instant, et non des compteurs cumulés : révoquer une clé fait baisser api_keys, et supprimer un fichier fait baisser files. events est l'exception et ne fait jamais que monter, car un événement n'est jamais retiré.
Note —
planvautnulllorsque le projet n'a pas d'abonnement. Les décomptes sont tout de même renvoyés : traitez donc les deux parties de la réponse indépendamment.
Les décomptes présentés ici recoupent ce que rapportent les ressources individuelles : events compte tout le journal alors que Événements n'en liste que les 100 entrées les plus récentes, et api_keys compte les mêmes clés qu'énumère Clés API.