Obtenir l'activité récente d'un Agent

Obtenez le nombre de nouvelles sessions et de questions d'utilisateurs d'un ou plusieurs Agents au cours des N dernières minutes, approprié pour la vérification régulière de l'activité. Vous pouvez interroger jusqu'à 50 Agents à la fois.

Méthode de requête

GET

URL d'appel

https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity

Vérification de l'appel

Utilisez l'authentification Basic avec DevKey / DevSecret de niveau 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 disposer de l'autorisation « Voir l'utilisation » (les propriétaires et administrateurs de l'organisation sont automatiquement autorisés), et doit également pouvoir accéder à cet Agent : créateur de l'Agent, propriétaire de l'organisation, ou membre ayant reçu l'autorisation pour cet Agent (ou pour tous les Agents).
Veuillez appeler l'URL du centre de données où se trouve votre organisation, ${endpoint} étant le region renvoyé par Lister les organisations (SG → sg, TH → th, JP → jp). Un appel depuis un autre centre de données renverra « Pas membre de cette organisation ».

Fréquence d'appel

Chaque clé développeur peut appeler cette interface au maximum 60 fois par minute.
Chaque appel compte également dans le quota par minute de l'API « Statistiques » de l'organisation, partagé avec les appels des clés d'API Agent aux interfaces statistiques.
Les résultats de la requête sont mis en cache pendant 30 secondes ; il est recommandé d'appeler cette interface une fois par minute et de combiner plusieurs Agents en une seule requête.

Requête

Exemple de requête

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity?org_id=${org_id}&agent_id=${agent_id_1},${agent_id_2}&minutes=5' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity?org_id=${org_id}&agent_id=${agent_id_1},${agent_id_2}&minutes=5' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

Ce bloc de code dans la fenêtre flottante

En-têtes de requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utiliser le token Basic après avoir encodé `DevKey:DevSecret` en Base64.

Paramètres de requête

Champ	Type	Obligatoire	Description
org_id	String	Oui	ID de l'organisation.
agent_id	String	Oui	ID de l'agent, plusieurs séparés par des virgules anglaises, maximum 50, les doublons ne sont comptés qu'une fois. Workflow non pris en charge.
minutes	Integer	Non	Statistiques des dernières minutes, de 1 à 60, par défaut 5.

Réponse

Exemple de réponse

{ "code": 0, "message": "OK", "data": { "minutes": 5, "window_start": 1790664900000, "window_end": 1790665200000, "agents": [ { "agent_id": "65f0c2a1b4e8d93a1c7e5b21", "new_conversation_count": 3, "new_message_count": 27 } ] } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "minutes": 5,
        "window_start": 1790664900000,
        "window_end": 1790665200000,
        "agents": [
            {
                "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                "new_conversation_count": 3,
                "new_message_count": 27
            }
        ]
    }
}

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
minutes	Integer	Longueur de la fenêtre statistique (minutes).
window_start	Long	Début de la fenêtre (timestamp en millisecondes).
window_end	Long	Fin de la fenêtre (timestamp en millisecondes, non inclus).
agents[].agent_id	String	ID de l'agent, dans le même ordre que `agent_id` dans la requête.
agents[].new_conversation_count	Long	Nombre de conversations créées dans la fenêtre et ayant déjà eu un échange.
agents[].new_message_count	Long	Nombre de questions posées par les utilisateurs dans la fenêtre, sans inclure les réponses de l'IA.

Réponse échouée

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'erreur

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

Code d'erreur	Description
40000	Erreur de paramètre, par exemple paramètre obligatoire manquant ou valeur de paramètre non valide.
40001	Appels trop fréquents : cette clé développeur a dépassé la limite par minute de cette API.
40008	Dépassement du quota par minute de l'abonnement de l'organisation pour les "APIs statistiques".
40010	L'interface est temporairement fermée, veuillez réessayer plus tard.
40100	Permission manquante : pas d'autorisation pour consulter l'utilisation ou voir cet agent (y compris si l'agent n'appartient pas à l'organisation).
40105	Non membre de l'organisation ou utilisation de l'adresse d'un autre centre de données.
40324	DevKey ou DevSecret incorrect.
40378	Agent supprimé.
403132	Plage temporelle invalide : l'heure de début n'est pas antérieure à l'heure de fin, ou dépasse la plage de requête maximale.

Méthodologie statistique

Considérer les deux chiffres : Les sessions des canaux de messagerie instantanée restent actives dans la même session tant qu'aucun nouveau message n'apparaît pendant 60 minutes. Un agent actif sur un canal peut également ne pas avoir de nouvelle session pendant longtemps ; ne regarder que le nombre de nouvelles sessions pourrait conduire à une mauvaise interprétation de l’inactivité.
Portée des statistiques : Seuls les canaux de l’espace de développement sont comptabilisés, y compris l’API, les pages de partage, l’intégration sur site web, le composant bulle, LiveDesk ainsi que tous les canaux de messagerie instantanée et téléphoniques ; les aperçus de débogage dans l’espace de développement et l’utilisation de cet agent dans l’espace de travail ne sont pas inclus.
Fréquence de mise à jour : Calcul en temps réel.