Obtenir le RPM de pointe d'un Agent
Obtenez le RPM de pointe (nombre de requêtes par minute) d'un Agent pendant une plage de temps, tout en renvoyant le moment où le pic a eu lieu, le RPM moyen et le nombre total de requêtes.
Remarque : vous pouvez interroger des données sur un maximum de 31 jours ; seules les chaînes de l'espace de développement sont comptées, la portée de la statistique est indiquée ci-dessous dans « Critères de statistique ».
Méthode de requête
GET
URL d'appel
https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/rpm
Authentification de l'appel
Utilisez l'authentification Basic avec 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_idet avoir l'autorisation « Voir l'utilisation » (les propriétaires et administrateurs de l'organisation l'ont par défaut), et doit également pouvoir voir cet Agent : le créateur de l'Agent, le propriétaire de l'organisation, ou un membre à qui l'autorisation sur cet Agent (ou tous les Agents) a été accordée. - Veuillez appeler l'URL du centre de données de l'organisation,
${endpoint}doit prendreregionrenvoyé par Liste des 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é de développeur peut appeler cette API jusqu'à 60 fois par minute.
- Chaque appel compte également dans le quota « API statistique » de l'organisation par minute, partagé avec les appels d'API statistique avec la clé Agent API.
- Les données sont mises à jour toutes les heures ; pour la même heure, les requêtes répétées renvoient le même résultat, il est recommandé d'appeler une fois par heure.
Requête
Exemple de requête
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/rpm?org_id=${org_id}&agent_id=${agent_id}&start_time=1788192000000&end_time=1788796800000' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
En-tête de requête
| Champ | Type | Description |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Utilisation de DevKey:DevSecret après encodage Base64 du Token Basic. |
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. Workflow non pris en charge. |
| start_time | Long | Oui | Heure de début, horodatage en millisecondes. Ajusté à l'heure pleine inférieure. |
| end_time | Long | Oui | Heure de fin (non inclus), horodatage en millisecondes. Ajusté à l'heure pleine supérieure. L'intervalle après ajustement ne peut pas dépasser 31 jours. |
| conversation_type | String | Non | Voir uniquement un canal spécifique, tel que API, SHARE, EMBED, WIDGET, LIVEDESK. Ne peut être qu'un canal de l'espace de développement ; si non fourni, tous les canaux de l'espace de développement sont comptés. |
Réponse
Exemple de réponse
{
"code": 0,
"message": "OK",
"data": {
"agent_id": "65f0c2a1b4e8d93a1c7e5b21",
"range_start": 1788192000000,
"range_end": 1788796800000,
"data_until": 1788793200000,
"peak_rpm": 42,
"peak_at": 1788512460000,
"avg_rpm": 3.18,
"total_requests": 18234
}
}
Réponse réussie
| Champ | Type | Description |
|---|---|---|
| agent_id | String | ID de l'agent. |
| range_start | Long | Point de départ de l'intervalle statistique réel : start_time aligné vers le bas à l'heure pile en millisecondes. |
| range_end | Long | Point de fin de l'intervalle statistique réel (non inclus) : end_time aligné vers le haut à l'heure pile en millisecondes. |
| data_until | Long | Moment jusqu'où les données ont été comptabilisées (horodatage en millisecondes). Les parties de l'intervalle après ce moment n'ont pas encore de données. |
| peak_rpm | Long | RPM maximum : somme des demandes de tous les canaux dans la même minute, correspondant au nombre maximal de demandes dans une minute de l'intervalle. |
| peak_at | Long | Point de départ de la minute de pic (horodatage en millisecondes). En cas d'égalité entre plusieurs minutes, choisir la plus ancienne ; si aucune demande dans l'intervalle, null. |
| avg_rpm | Number | RPM moyen : total des demandes ÷ nombre de minutes avec demande, arrondi à 2 décimales. |
| total_requests | Long | Nombre total de demandes dans l'intervalle. |
Réponse échouée
| Champ | Type | Description |
|---|---|---|
| code | Integer | Code d'erreur. |
| message | String | Détails de l'erreur. |
Codes d'erreur
Le code de statut 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, tel que paramètre obligatoire manquant ou valeur de paramètre invalide. |
| 40001 | Appels trop fréquents : la clé développeur a dépassé la limite par minute de cette API. |
| 40008 | Dépassement du quota par minute de l'API de type statistique du forfait de l'organisation. |
| 40010 | L'interface est temporairement fermée, veuillez réessayer plus tard. |
| 40100 | Pas d'autorisation : autorisation de consultation de l’utilisation manquante, ou pas le droit de consulter cet Agent (y compris si l’Agent n’appartient pas à cette organisation). |
| 40105 | Pas membre de cette organisation, ou a appelé 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 des statistiques
- Requêtes : messages de questions envoyés par l’utilisateur, y compris les erreurs de conversation (y compris celles refusées en raison d’une fréquence d’appel dépassée), cohérents avec « Agent Insights → Requêtes par minute » du tableau de bord. Ce n’est pas le nombre de requêtes HTTP et peut différer du comptage des limitations du forfait.
- Portée des statistiques : seules les canaux de l’espace développeur sont comptés, y compris API, page de partage, intégration web, composants en bulle, LiveDesk, ainsi que tous les canaux de messagerie instantanée et téléphonie ; ne comprend pas l’aperçu de débogage dans l’espace développeur, l’exécution de Workflow, ni l’utilisation de l’Agent après sa publication dans l’espace de travail.
- Fréquence de mise à jour : les données sont comptées chaque heure pile, avec un délai d’environ 1 heure, basé sur
data_until. Les données avant le 09-03-2026 ne contiennent pas de détails au niveau minute, le résultat de la requête étant 0.
