Obtenir le résumé de l'utilisation de l'organisation

Obtenez le total de la consommation de crédits, du nombre de nouvelles sessions et du nombre de questions posées par les utilisateurs dans l'organisation selon l'intervalle de temps, et développez-les par Agent / Workflow en pages. Un seul appel permet d'obtenir les données de tous les Agents de l'organisation, il n'est pas nécessaire d'appeler chaque Agent individuellement.

Remarque : la requête peut couvrir au maximum 31 jours ; seules les données de l'espace de développement sont comptées, la portée de la statistique est décrite ci-dessous dans « Calibrage statistique ».

Méthode de requête

GET

URL de l'API

https://api-${endpoint}.gptbots.ai/v1/org/stat/summary

Vérification de l'appel

Utilisez l'authentification Basic avec le DevKey / DevSecret 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 correspondante à org_id et disposer de la permission « Voir l'utilisation » (les propriétaires et administrateurs de l'organisation l'ont par défaut).
• Veuillez utiliser l'URL du centre de données où se trouve l'organisation, ${endpoint} est obtenu à partir de region retourné par Liste des organisations (SG → sg, TH → th, JP → jp). L'appel à un autre centre de données renverra « pas membre de cette organisation ».

Fréquence des appels

• Chaque clé de développeur peut appeler cette interface au maximum 60 fois par minute.
• Chaque appel est comptabilisé dans le quota de chaque minute de l'organisation pour les « API statistiques », partageant le quota avec les appels d'interface de l'Agent API Key des interfaces statistiques.
• Les résultats des requêtes d'aujourd'hui ou d'hier sont mis en cache pendant 5 minutes, ceux des dates antérieures pendant 1 heure. Il est recommandé d'appeler toutes les 5 à 15 minutes.

Requête

Exemple de requête

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/summary?org_id=${org_id}&start_time=1792425600000&end_time=1795017600000&page=1&page_size=20' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    

En-têtes de la requête

Paramètres de la requête

Réponse

Exemple de réponse

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "org_id": "65f0c2a1b4e8d93a1c7e5b20",
        "timezone": "+07:00",
        "range_start_date": "2026-10-16",
        "range_end_date": "2026-11-14",
        "data_since": "2026-10-15",
        "data_until": 1794614400000,
        "total": {
            "credits": 1234.5678,
            "unattributed_credits": 36.2011,
            "conversation_count": 5210,
            "message_count": 48213
        },
        "agents": {
            "page": 1,
            "page_size": 20,
            "total": 86,
            "list": [
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                    "name": "客服助手",
                    "agent_type": "AGENT",
                    "credits": 402.1200,
                    "conversation_count": 2104,
                    "message_count": 19820
                },
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                    "name": "订单查询",
                    "agent_type": "WORKFLOW",
                    "credits": 130.5000,
                    "conversation_count": null,
                    "message_count": null
                }
            ]
        }
    }
}

                    

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.

Méthodologie de statistiques

• Plage statistique : Seule la zone de développement est comptée, y compris API, pages de partage, intégration web, composants bulles, LiveDesk ainsi que tous les canaux de messagerie instantanée et téléphonie, et les Workflow de la zone de développement ; cela n’inclut pas l’usage du Workspace (GWork), ni l’usage des Agents publiés dans le Workspace.
• Crédits : Tous les types de consommation (hors expiration de crédits et paiement d’abonnement). La consommation des Workflow est enregistrée sous le nom du Workflow lui-même, la consommation générée par un Agent appelant un Workflow n’est pas comptée pour cet Agent. Les données de crédits sont disponibles à partir de la date de mise en ligne de la fonctionnalité (data_since), les données historiques ne sont pas réintégrées.
• Nombre de sessions : Nombre de sessions créées dans la période et ayant déjà eu des conversations, sans inclure l’aperçu de débogage de la zone de développement. L’exécution des Workflow ne génère pas de sessions ; la recherche AI dans le Workspace n’est pas comptée. Les nombres de sessions et de questions sont disponibles à partir de 31 jours avant la mise en ligne de la fonctionnalité.
• Nombre de questions : Nombre de messages de questions envoyés par les utilisateurs pendant la période, sans inclure les réponses AI.
• Classement : agents.list est classé par crédits de manière décroissante, en cas d’égalité, par nombre de sessions. Les Agents sans aucun point, session ou question pendant la période ne sont pas listés.
• Fréquence de mise à jour : Les crédits sont mis à jour en temps réel ; le nombre de sessions et de questions est comptabilisé chaque heure pile, avec un retard d’environ 1 heure.