Obtention du taux de transfert d'un Agent vers un humain
Obtenez, sur une plage de temps donnée, le nombre de conversations d'un Agent, le nombre de conversations transférées à un humain et le taux de transfert vers un humain, avec la même méthodologie que le tableau de bord « Agent Insights → Taux de transfert vers un humain ».
Remarque : il est possible de consulter les données sur un maximum de 92 jours ; seules les chaînes de l'espace de développement sont comptées, voir la section « Méthodologie statistique » ci-dessous pour la portée de la statistique.
Méthode de requête
GET
Adresse d'appel
https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/human-handoff
Authentification de l'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 appelé doit être membre de l'organisation correspondant à
org_idet disposer de l'autorisation « Voir l'utilisation » (par défaut accordée au propriétaire et à l'administrateur de l'organisation), et doit pouvoir consulter cet Agent : le créateur de l'Agent, le propriétaire de l'organisation, ou un membre ayant reçu les permissions sur cet Agent (ou sur tous les Agents). - Veuillez appeler l'adresse du centre de données où se trouve l'organisation.
${endpoint}correspond àregionrenvoyé par la liste des organisations (SG→sg,TH→th,JP→jp). Lorsqu'on appelle un autre centre de données, le message « N'est pas membre de cette organisation » sera renvoyé.
Fréquence des appels
- Chaque clé de développeur peut appeler cette API jusqu'à 60 fois par minute.
- Chaque appel compte également dans le quota « API statistiques » de l'organisation par minute, partagé avec les appels d'API statistiques utilisant la clé Agent.
- Les résultats des requêtes sont mis en cache pendant 10 minutes, il est recommandé d'effectuer un appel par heure.
Requête
Exemple de requête
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/human-handoff?org_id=${org_id}&agent_id=${agent_id}&start_time=1788192000000&end_time=1790784000000' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
En-tête de la requête
| Champ | Type | Description |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Utiliser le token Basic après DevKey:DevSecret en Base64. |
Paramètres de la requête
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| org_id | String | Oui | ID de l'organisation. |
| agent_id | String | Oui | ID de l'agent. Workflow non pris en charge. |
| start_time | Long | Oui | Heure de début, timestamp en millisecondes. Étendu à 0h du jour selon le fuseau horaire de l'organisation. |
| end_time | Long | Oui | Heure de fin (exclue), timestamp en millisecondes. Selon le fuseau horaire de l'organisation, prendre le jour naturel de la milliseconde précédente comme dernier jour. La plage de dates de début à fin ne doit pas dépasser 92 jours. |
Réponse
Exemple de réponse
{
"code": 0,
"message": "OK",
"data": {
"agent_id": "65f0c2a1b4e8d93a1c7e5b21",
"timezone": "+08:00",
"range_start_date": "2026-09-01",
"range_end_date": "2026-09-29",
"data_until": 1790665200000,
"conversation_count": 1200,
"handoff_conversation_count": 96,
"handoff_rate": 0.0800
}
}
Réponse réussie
| Champ | Type | Description |
|---|---|---|
| agent_id | String | ID de l'agent. |
| timezone | String | Fuseau horaire de l'organisation (décalage UTC, comme +08:00), indiquant selon quel fuseau horaire les dates sont découpées. |
| range_start_date | String | Date de début réelle des statistiques yyyy-MM-dd (fuseau horaire de l'organisation, inclus). |
| range_end_date | String | Date de fin réelle des statistiques yyyy-MM-dd (fuseau horaire de l'organisation, inclus). |
| data_until | Long | Instant jusqu'auquel les données ont été comptabilisées (timestamp en millisecondes) : si la période comprend des dates calculées en temps réel, il s'agit du moment du calcul de la partie en temps réel (les résultats sont mis en cache au maximum 10 minutes) ; si toute la période a déjà été comptabilisée quotidiennement, il s'agit du point final de la période. |
| conversation_count | Long | Nombre de conversations ayant eu lieu pendant la période (cumulé par jour). |
| handoff_conversation_count | Long | Nombre de conversations transférées à un agent humain. |
| handoff_rate | Number | Taux de transfert vers un humain = handoff_conversation_count ÷ conversation_count, de 0 à 1, avec 4 décimales ; si le nombre de conversations est 0, alors null. |
Réponse échouée
| Champ | Type | Description |
|---|---|---|
| code | Integer | Code d'erreur. |
| message | String | Détails de l'erreur. |
Codes d'erreur
Le code HTTP correspond aux trois premiers chiffres du code d'erreur, par exemple 40000 correspond à 400, 40100 correspond à 401, 403132 correspond à 403.
| Code d'erreur | Description |
|---|---|
| 40000 | Erreur de paramètre, comme l'absence de paramètres obligatoires ou des valeurs de paramètres non valides. |
| 40001 | Appels trop fréquents : cette clé de développeur a dépassé la limite par minute de cette API. |
| 40008 | Dépassement du quota par minute de « API statistiques » du forfait organisation. |
| 40010 | API temporairement fermée, veuillez réessayer plus tard. |
| 40100 | Pas d'autorisation : manque de permission pour consulter l'utilisation, ou pas le droit de voir cet Agent (y compris si l'Agent n'appartient pas à l'organisation). |
| 40105 | Pas membre de cette organisation, ou appel depuis l'adresse d'un autre centre de données. |
| 40324 | DevKey ou DevSecret incorrect. |
| 40378 | Agent supprimé. |
| 403132 | Plage horaire 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
- Nombre de sessions : nombre de sessions ayant eu au moins une conversation par jour, additionné quotidiennement ; les conversations qui se prolongent sur plusieurs jours sont comptées chaque jour.
- Nombre de sessions transférées à un humain : nombre de sessions transférées à un agent humain.
- Périmètre statistique : ne comptabilise que les canaux de l’espace développeur, y compris API, page de partage, intégration sur site web, composant popup, LiveDesk et tous les canaux de messagerie instantanée et téléphonie ; ne comprend pas l’utilisation de cet Agent après sa publication dans l’espace de travail.
- Fréquence de mise à jour : les dates des statistiques quotidiennes terminées récupèrent les statistiques quotidiennes ; calcul en temps réel le jour même. Les statistiques quotidiennes sont générées par la tâche statistique après minuit dans le fuseau horaire de l’organisation ; avant la génération, la veille est également calculée en temps réel, de sorte qu’après minuit, « hier » n’est pas à 0.
- Méthodologie des données en temps réel : comptabilisé selon l’heure du dernier échange de la session, les conversations prolongées sur plusieurs jours ne sont comptées qu’une seule fois dans la partie en temps réel (comptée le jour du dernier échange), ce qui peut légèrement différer des statistiques quotidiennes cumulatives.
