Obtenir la répartition de l'utilisation des crédits de l'organisation

Obtenez le classement de la proportion de crédits ou de tokens de l'organisation par Agent / Workflow, ainsi que la tendance quotidienne, hebdomadaire et mensuelle. Il est possible de regarder uniquement Agent ou uniquement Workflow.

Remarque : il est possible de consulter des données sur un maximum de 92 jours ; seules les données des espaces de développement sont comptabilisées, la portée statistique est décrite ci-dessous sous « Portée de la statistique ».

Méthode de requête

GET

URL d'appel

https://api-${endpoint}.gptbots.ai/v1/org/usage/distribution

Vérification d'appel

Utilisez l'authentification Basic avec le DevKey / DevSecret au niveau du compte : Authorization: Basic ${BASIC_TOKEN}, où ${BASIC_TOKEN} est l'encodage Base64 de DevKey:DevSecret.

• Le compte appelant doit être membre de l'organisation correspondant à org_id et avoir l'autorisation « Voir l'utilisation » (les propriétaires et administrateurs de l'organisation l'ont par défaut).
• Veuillez appeler l'adresse du centre de données où se trouve l'organisation, ${endpoint} correspond à region renvoyé par Lister les organisations (SG → sg, TH → th, JP → jp). Appeler un autre centre de données renverra « Pas membre de cette organisation ».

Fréquence d'appel

• Chaque clé développeur peut appeler cette API au maximum 10 fois par minute.
• Chaque appel est également compté dans le quota par minute du « API statistique » du forfait organisation, partagé avec l’API statistique Agent Key.
• Les résultats des requêtes sont mis en cache pendant 10 minutes, il est recommandé d’appeler une fois par jour.

Requête

Exemple de requête

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/usage/distribution?org_id=${org_id}&start_time=1792425600000&end_time=1792684800000&agent_type=WORKFLOW&granularity=DAY' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    

En-tête de la requête

Paramètres de la requête

Réponse

Exemple de réponse

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "timezone": "+07:00",
        "data_since": "2026-10-15",
        "buckets": ["2026-10-16", "2026-10-17", "2026-10-18"],
        "total": 812.4411,
        "series": [
            {
                "row_type": "ITEM",
                "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                "name": "订单查询",
                "agent_type": "WORKFLOW",
                "total": 402.1200,
                "share": 49.49,
                "points": [130.5000, 141.0200, 130.6000]
            },
            {
                "row_type": "OTHER",
                "agent_id": null,
                "name": null,
                "agent_type": null,
                "total": 410.3211,
                "share": 50.51,
                "points": [120.1000, 150.2000, 140.0211]
            }
        ],
        "ranking": [
            {
                "row_type": "ITEM",
                "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                "name": "订单查询",
                "agent_type": "WORKFLOW",
                "total": 402.1200,
                "share": 49.49
            }
        ]
    }
}

                    

Réponse réussie

Réponse en cas d'échec

Codes d'erreur

Le code HTTP correspond aux trois premiers chiffres du code d'erreur, par exemple 40000 correspond à 400, 40100 à 401, 403132 à 403.

Périmètre statistique

• Portée des statistiques : seules les zones de développement sont comptées, y compris API, pages de partage, intégrations web, composants de bulles, LiveDesk ainsi que tous les canaux de messagerie instantanée et d'appel, ainsi que les Workflows de l'espace de développement ; l'utilisation des espaces de travail (GWork) n'est pas incluse, et la partie utilisée par un Agent publié dans un espace de travail n'est pas non plus incluse. Par conséquent, le total peut être légèrement inférieur à celui affiché dans la page « Organisation → Utilisation » de la console pour la même période.
• Crédits : tous les types de consommation (à l'exception de l'expiration des crédits et du paiement par abonnement) ; la consommation des Workflows est enregistrée sous le nom du Workflow lui-même.
• Point de départ des données : disponible à partir de la date de mise en ligne de la fonctionnalité (data_since), sans rétroaction historique.
• Fréquence de mise à jour : mise à jour en temps réel.