logo
Développement
Rechercher
Obtenir le RPM maximum de l'organisation

Obtenir le RPM maximum de l'organisation

Obtenez le RPM (requêtes par minute) maximum de l'organisation sur un intervalle de temps : additionnez d'abord le nombre de requêtes de tous les agents de l'organisation pour chaque minute, puis sélectionnez la minute la plus élevée dans l'intervalle. Retournez également le moment où le pic s'est produit, le RPM moyen et le nombre total de requêtes.

Remarque : seuls les données sur une période maximale de 31 jours peuvent être consultées ; seules les canaux de l'espace développeur sont comptés. La portée des statistiques est indiquée ci-dessous sous « Méthode de calcul ».

Méthode de requête

GET

URL d'appel

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

Authentification 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 correspondant à org_id et disposer de l'autorisation « Voir l'utilisation » (les propriétaires et administrateurs de l'organisation disposent automatiquement de cette autorisation).
  • Veuillez appeler l'adresse du centre de données où se trouve l'organisation, ${endpoint} doit être pris dans Consulter la liste des organisations retournant region (SG → sg, TH → th, JP → jp). Appeler un autre centre de données renverra « Vous n'êtes pas membre de cette organisation ».

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 » par minute du forfait organisation, partagé avec les appels aux interfaces statistiques via Agent API Key.
  • Les données sont mises à jour toutes les heures ; les requêtes répétées dans la même heure renverront le même résultat. Il est recommandé d'appeler l'API une fois par heure.

Requête

Exemple de requête

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm?org_id=${org_id}&start_time=1788192000000&end_time=1788796800000' \ -H 'Authorization: Basic ${BASIC_TOKEN}'
                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm?org_id=${org_id}&start_time=1788192000000&end_time=1788796800000' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    
Ce bloc de code dans la fenêtre flottante

En-tête de requête

Champ Type Description
Authorization Basic ${BASIC_TOKEN} Utiliser le Basic Token après DevKey:DevSecret en Base64.

Paramètres de requête

Champ Type Obligatoire Description
org_id String Oui ID de l'organisation.
start_time Long Oui Heure de début, timestamp en millisecondes. Arrondi à l'heure entière inférieure.
end_time Long Oui Heure de fin (non incluse), timestamp en millisecondes. Arrondi à l'heure entière supérieure. L'intervalle après alignement ne doit pas dépasser 31 jours.

Réponse

Exemple de réponse

{ "code": 0, "message": "OK", "data": { "org_id": "65f0c2a1b4e8d93a1c7e5b20", "range_start": 1788192000000, "range_end": 1788796800000, "data_until": 1788793200000, "data_since": 1786125600000, "peak_rpm": 186, "peak_at": 1788512460000, "avg_rpm": 12.40, "total_requests": 2083411 } }
                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "org_id": "65f0c2a1b4e8d93a1c7e5b20",
        "range_start": 1788192000000,
        "range_end": 1788796800000,
        "data_until": 1788793200000,
        "data_since": 1786125600000,
        "peak_rpm": 186,
        "peak_at": 1788512460000,
        "avg_rpm": 12.40,
        "total_requests": 2083411
    }
}

                    
Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ Type Description
org_id String ID de l'organisation.
range_start Long Point de départ de l'intervalle statistique réel : start_time arrondi vers le bas à l'heure pleine en millisecondes.
range_end Long Point de fin de l'intervalle statistique réel (exclu) : end_time arrondi vers le haut à l'heure pleine en millisecondes.
data_until Long Moment jusqu'où les données ont été comptabilisées (timestamp en millisecondes). Les parties de l'intervalle plus tardives n'ont pas encore de données.
data_since Long Heure à laquelle le RPM de l'organisation commence à avoir des données à partir d'une heure pleine (timestamp en millisecondes, identique pour toutes les organisations du même centre de données, environ 31 jours avant la mise en ligne de la fonctionnalité). Les parties de l'intervalle antérieures à ce moment n'ont pas de données ; si aucune donnée n'est encore disponible, valeur null.
peak_rpm Long RPM de pointe : le nombre de requêtes totalisées pour tous les agents de l'organisation pendant une même minute, la minute qui atteint le maximum dans l'intervalle.
peak_at Long Début de la minute où se produit le pic (timestamp en millisecondes). En cas d'égalité entre plusieurs minutes, prendre la première ; si aucune requête dans l'intervalle, valeur null.
avg_rpm Number RPM moyen : nombre total de requêtes ÷ nombre de minutes avec requêtes, arrondi à 2 décimales.
total_requests Long Nombre total de requêtes dans l'intervalle.

Réponse en cas d'échec

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 correspond à 401, 403132 correspond à 403.

Code d'erreur Description
40000 Erreur de paramètre, comme un paramètre obligatoire manquant ou une valeur de paramètre invalide.
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 du « API statistique » du pack organisationnel.
40010 L'API est temporairement fermée, veuillez réessayer plus tard.
40100 Pas d'autorisation : absence de permission pour consulter l'utilisation.
40105 Non membre de cette organisation, ou appel à l'adresse d’un autre centre de données.
40324 DevKey ou DevSecret incorrect.
403132 Plage horaire invalide : l'heure de début n'est pas antérieure à l'heure de fin, ou dépasse la plage maximale de requête.

Méthodologie statistique

  • Requêtes : messages de question envoyés par l'utilisateur, y compris les erreurs de dialogue (y compris les requêtes rejetées pour dépassement de la fréquence d'appel), correspondant à « Agent Insights → Requêtes par minute » dans la console. Ce n’est pas le nombre de requêtes HTTP et peut différer du comptage utilisé pour la limitation de forfait.
  • Portée statistique : seules sont comptées les requêtes de l’Agent de l’espace développeur sur les canaux de l’espace développeur, y compris l’API, la page de partage, l’intégration web, les composants flottants, LiveDesk et tous les canaux de messagerie instantanée et téléphonie ; cela n’inclut pas la prévisualisation de débogage dans l’espace développeur, Workflow (y compris les appels à l’API Workflow rejetés pour dépassement de fréquence), la recherche IA de l’espace de travail, ni l’utilisation des Agents publiés dans l’espace de travail.
  • Portée des données : les données sont disponibles à partir de 31 jours avant le lancement de la fonctionnalité, les périodes antérieures sont indiquées par data_since.
  • Fréquence de mise à jour : les données sont comptabilisées toutes les heures pile, avec environ 1 heure de retard, comme indiqué par data_until.
  • Différence avec la page « Organisation → Utilisation → RPM » de la console : la console affiche par 24 segments horaires sur une journée, tandis que cette API retourne un seul pic sur toute la période et le moment de son occurrence.