Abrufen der Spitzen-RPM eines Agenten

Abrufen der Spitzen-RPM (Anfragen pro Minute) eines bestimmten Agenten innerhalb eines bestimmten Zeitraums, gleichzeitig mit Rückgabe des Zeitpunkts des Spitzenwerts, der durchschnittlichen RPM und der Gesamtzahl der Anfragen.

Hinweis: Es können maximal Daten für 31 Tage abgefragt werden; es werden nur Kanäle des Entwicklungsbereichs gezählt, der statistische Bereich siehe unten unter „Statistische Definition“.

Anfragemethode

GET

Aufrufadresse

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

Authentifizierung des Aufrufs

Verwenden Sie Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene: Authorization: Basic ${BASIC_TOKEN}, wobei ${BASIC_TOKEN} die Base64-Codierung von DevKey:DevSecret ist.

Das aufrufende Konto muss Mitglied der Organisation sein, die org_id entspricht, und über die Berechtigung „Nutzung anzeigen“ verfügen (Organisations-Owner und Administratoren verfügen standardmäßig darüber), zudem muss es den Agenten einsehen können: Ersteller des Agenten, Organisations-Owner oder Mitglieder, denen die Berechtigung für diesen Agenten (oder für alle Agenten) erteilt wurde.
Bitte rufen Sie die Adresse des Rechenzentrums der Organisation auf, ${endpoint} wird aus der Abfrage der Organisationsliste zurückgegeben: region (SG → sg, TH → th, JP → jp). Ein Aufruf eines anderen Rechenzentrums führt zur Meldung „Nicht Mitglied der Organisation“.

Aufrufhäufigkeit

Jeder Developer Key darf diese Schnittstelle maximal 60 Mal pro Minute aufrufen.
Jeder Aufruf wird gleichzeitig auf das Organisationspaket „Statistische APIs“ pro Minute angerechnet und teilt sich dieses Kontingent mit API-Aufrufen über den Agent-API-Key.
Die Daten werden stündlich aktualisiert; wiederholte Abfragen innerhalb derselben Stunde geben dasselbe Ergebnis zurück, empfohlen wird ein Aufruf pro Stunde.

Anfrage

Anfragebeispiel

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}'

                      
                      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}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Verwenden Sie den Basic-Token nach `DevKey:DevSecret` Base64.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
org_id	String	Ja	Organisations-ID.
agent_id	String	Ja	Agent-ID. Workflow wird nicht unterstützt.
start_time	Long	Ja	Startzeit, Zeitstempel in Millisekunden. Auf die nächste volle Stunde abgerundet.
end_time	Long	Ja	Endzeit (nicht eingeschlossen), Zeitstempel in Millisekunden. Auf die nächste volle Stunde aufgerundet. Der angepasste Zeitraum darf 31 Tage nicht überschreiten.
conversation_type	String	Nein	Nur ein bestimmter Kanal, z. B. `API`, `SHARE`, `EMBED`, `WIDGET`, `LIVEDESK`. Nur Kanäle des Entwicklungsbereichs sind erlaubt; wenn nicht angegeben, werden alle Kanäle des Entwicklungsbereichs gezählt.

Antwort

Antwortbeispiel

{ "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 } }

                      
                      {
    "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
    }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
agent_id	String	Agenten-ID.
range_start	Long	Startpunkt des tatsächlichen Statistikzeitraums: `start_time` nach unten auf die volle Stunde ausgerichteter Millisekunden-Zeitstempel.
range_end	Long	Endpunkt des tatsächlichen Statistikzeitraums (exklusiv): `end_time` nach oben auf die volle Stunde ausgerichteter Millisekunden-Zeitstempel.
data_until	Long	Zeitpunkt, bis zu dem die Daten bereits statistisch erfasst sind (Millisekunden-Zeitstempel). Teile im Zeitraum, die später als dieser Zeitpunkt liegen, haben noch keine Daten.
peak_rpm	Long	Spitzen-RPM: Summe der Anfragen aller Kanäle in derselben Minute, größter Wert innerhalb des Zeitraums.
peak_at	Long	Startpunkt der Minute mit dem Spitzenwert (Millisekunden-Zeitstempel). Bei mehreren Minuten mit demselben Wert wird die früheste Minute genommen; wenn es im Zeitraum keine Anfragen gibt, `null`.
avg_rpm	Number	Durchschnittliche RPM: Gesamtanzahl der Anfragen ÷ Anzahl der Minuten mit Anfragen, auf 2 Dezimalstellen gerundet.
total_requests	Long	Gesamtzahl der Anfragen im Zeitraum.

Fehlgeschlagene Antwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlermeldung.

Fehlercodes

HTTP-Statuscode entspricht den ersten drei Ziffern des Fehlercodes, z. B. 40000 entspricht 400, 40100 entspricht 401, 403132 entspricht 403.

Fehlercode	Beschreibung
40000	Parameterfehler, z. B. fehlender Pflichtparameter oder ungültiger Parameterwert.
40001	Zu häufige Aufrufe: Dieser Entwickler-Schlüssel hat das Minutenlimit für diese Schnittstelle überschritten.
40008	Über dem monatlichen Limit des Organisationspakets für "Statistik-APIs" pro Minute.
40010	Schnittstelle vorübergehend geschlossen, bitte später erneut versuchen.
40100	Keine Berechtigung: Die Berechtigung zur Nutzungseinsicht fehlt oder es besteht keine Berechtigung, diesen Agenten einzusehen (einschließlich wenn der Agent nicht zu dieser Organisation gehört).
40105	Kein Mitglied dieser Organisation oder die Adresse eines anderen Rechenzentrums wurde aufgerufen.
40324	DevKey oder DevSecret ist falsch.
40378	Agent wurde gelöscht.
403132	Ungültiger Zeitraum: Startzeit ist nicht vor der Endzeit oder überschreitet den maximalen Abfragebereich.

Statistikdefinition

Anfragen: Vom Benutzer gestellte Fragen, einschließlich Fehlermeldungen im Dialog (einschließlich Anfragen, die aufgrund Überschreitung der Aufrufhäufigkeit abgelehnt wurden), stimmen mit der Konsole „Agent Insights → Anfragen pro Minute“ überein. Dies ist nicht die Anzahl der HTTP-Anfragen und kann von der Zählung im Rahmen des Tariflimits abweichen.
Statistikbereich: Zählt nur die Kanäle im Entwicklerraum, einschließlich API, Freigabeseite, Web-Embedding, Bubble-Komponente, LiveDesk sowie alle Sofortnachrichten- und Telefonkanäle; nicht enthalten sind Debug-Vorschau im Entwicklerraum, Workflow-Ausführung und Nutzung des Agenten im Workspace nach dessen Veröffentlichung dort.
Aktualisierungsfrequenz: Die Daten werden stündlich zur vollen Stunde aktualisiert, mit einer Verzögerung von etwa 1 Stunde, basierend auf data_until. Daten vor dem 09.03.2026 haben keine minutengenaue Aufschlüsselung; Abfrageergebnisse sind 0.