Abrufen des Spitzen-RPM der Organisation

Erhalte den Spitzen-RPM (Anfragen pro Minute) der Organisation über einen bestimmten Zeitraum: Zuerst werden die Anfragen aller Agents der Organisation in derselben Minute summiert, dann wird die Minute mit dem Maximum innerhalb des Zeitraums ausgewählt. Gleichzeitig werden der Zeitpunkt des Spitzenwerts, der durchschnittliche RPM und die Gesamtzahl der Anfragen zurückgegeben.

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

Anfragemethode

GET

Aufrufadresse

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

Authentifizierung beim Aufruf

Verwenden Sie die Basic-Authentifizierung mit account-spezifischem DevKey / DevSecret: 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 die Berechtigung „Nutzungsstatistiken ansehen“ besitzen (Organisation Owner oder Administrator haben diese standardmäßig).
Bitte rufen Sie die Adresse des Rechenzentrums ab, in dem sich die Organisation befindet; ${endpoint} erhält man aus dem Abfrage der Organisationsliste zurückgegebenen region (SG → sg, TH → th, JP → jp). Bei Aufruf anderer Rechenzentren wird „Nicht Mitglied dieser Organisation“ zurückgegeben.

Aufrufhäufigkeit

Jeder Entwickler-Schlüssel darf diese Schnittstelle maximal 60 Mal pro Minute aufrufen.
Jeder Aufruf wird gleichzeitig auf das Minuten-Kontingent der Kategorie „Statistik-APIs“ des Organisationstarifs angerechnet und teilt das Kontingent mit Aufrufen der Statistik-APIs unter Verwendung des Agent API Keys.
Die Daten werden stündlich aktualisiert; wiederholte Abfragen innerhalb derselben Stunde liefern das gleiche Ergebnis. Es wird empfohlen, einmal pro Stunde anzurufen.

Anfrage

Beispielanfrage

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

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

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

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
org_id	String	Ja	Organisations-ID.
start_time	Long	Ja	Startzeit, Zeitstempel in Millisekunden. Nach unten auf die volle Stunde ausgerichtet.
end_time	Long	Ja	Endzeit (nicht eingeschlossen), Zeitstempel in Millisekunden. Nach oben auf die volle Stunde ausgerichtet. Der ausgerichtete Zeitraum darf 31 Tage nicht überschreiten.

Antwort

Antwortbeispiel

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

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
org_id	String	Organisations-ID.
range_start	Long	Anfang des tatsächlichen Statistikbereichs: `start_time` nach unten auf den nächsten vollen Punkt ausgerichteter Millisekunden-Zeitstempel.
range_end	Long	Ende des tatsächlichen Statistikbereichs (nicht eingeschlossen): `end_time` nach oben auf den nächsten vollen Punkt ausgerichteter Millisekunden-Zeitstempel.
data_until	Long	Zeitpunkt, bis zu dem die Daten bereits erfasst wurden (Millisekunden-Zeitstempel). Daten nach diesem Zeitpunkt im Bereich liegen noch nicht vor.
data_since	Long	Ab welchem vollen Punkt die Organisation RPM-Daten hat (Millisekunden-Zeitstempel, für alle Organisationen im selben Rechenzentrum gleich, ungefähr 31 Tage vor Funktionsfreigabe). Daten vor diesem Zeitpunkt im Bereich liegen nicht vor; wenn noch keine Daten vorhanden sind, `null`.
peak_rpm	Long	Spitzen-RPM: Summe der Anfragen aller Agenten unter der Organisation in derselben Minute, die im Bereich die höchste Anzahl an Anfragen in einer Minute erreicht.
peak_at	Long	Startpunkt der Minute mit Spitzenwert (Millisekunden-Zeitstempel). Bei mehreren gleichwertigen Minuten wird die früheste Minute genommen; wenn im Bereich keine Anfragen vorliegen, `null`.
avg_rpm	Number	Durchschnittliche RPM: Gesamtanzahl der Anfragen ÷ Minuten mit Anfragen, auf 2 Nachkommastellen gerundet.
total_requests	Long	Gesamtanzahl der Anfragen im Bereich.

Fehlgeschlagene Antwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlermeldung im Detail.

Fehlercodes

Die HTTP-Statuscodes entsprechen den ersten drei Stellen 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 Entwicklerschlüssel hat das Minutenlimit für diese Schnittstelle überschritten.
40008	Das Minutenlimit des Organisationspakets für „Statistische APIs“ wurde überschritten.
40010	Schnittstelle vorübergehend geschlossen, bitte versuchen Sie es später erneut.
40100	Keine Berechtigung: Fehlende Berechtigung zur Nutzungseinsicht.
40105	Kein Mitglied dieser Organisation oder es wurde eine Adresse eines anderen Rechenzentrums aufgerufen.
40324	DevKey oder DevSecret ist falsch.
403132	Ungültiger Zeitbereich: Startzeit liegt nicht vor der Endzeit oder überschreitet die maximale Abfragereichweite.

Statistische Methodik

Anfragen: Vom Nutzer gesendete Frage-Nachrichten, einschließlich Fehlermeldungen im Dialog (einschließlich Anfragen, die aufgrund zu hoher Aufrufhäufigkeit abgelehnt wurden), entsprechend der Konsole „Agent Insights → Anfragen pro Minute“. Dies entspricht nicht der Anzahl der HTTP-Anfragen und kann von der Zählung für das Paket-Limit abweichen.
Statistikbereich: Es werden nur Anfragen von Agents des Entwicklungsbereichs über dessen Kanäle gezählt, einschließlich API, Sharing-Seite, Web-Embedding, Bubble-Komponente, LiveDesk und alle Instant-Messaging- und Telefonkanäle; nicht enthalten sind Debug-Previews im Entwicklungsbereich, Workflows (einschließlich API-Aufrufe von Workflows, die wegen Überschreitung der Aufrufhäufigkeit abgelehnt wurden), AI-Suche im Workspace und Nutzung veröffentlichter Agents im Workspace.
Datenbereich: Daten sind ab 31 Tage vor dem Funktionsstart verfügbar; frühere Zeiträume richten sich nach data_since.
Aktualisierungsfrequenz: Daten werden stündlich zur vollen Stunde aktualisiert, etwa 1 Stunde verzögert, gültig gemäß data_until.
Unterschied zur Konsole „Organisation → Nutzung → RPM“: Die Konsole zeigt 24 Stunden pro Tag an, diese Schnittstelle liefert einen einzelnen Spitzenwert für den Gesamtzeitraum und den Zeitpunkt des Auftretens.