Abrufen der Agent-zu-Mensch-Rate
Abrufen der Sitzungsanzahl, der Sitzungen, die an einen Menschen weitergeleitet wurden, und der Weiterleitungsrate eines bestimmten Agenten nach Zeitintervall. Die Berechnungsmethode entspricht der Konsole „Agent Insights → Weiterleitungsrate“.
Hinweis: Es können maximal Daten für 92 Tage abgefragt werden; es werden nur Kanäle des Entwicklungsbereichs gezählt, der statistische Bereich ist unten unter „Statistische Definitionen“ aufgeführt.
Anfragemethode
GET
Aufrufadresse
https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/human-handoff
Aufruf-Verifizierung
Verwendung der Basic-Authentifizierung mit Kontoebene 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 zu
org_idgehört, und die Berechtigung „Nutzungsansicht“ besitzen (Organisations-Owner und Administratoren besitzen diese standardmäßig), außerdem muss es den Agent einsehen können: Agent-Ersteller, Organisations-Owner oder Mitglieder, denen die Berechtigung für diesen Agenten (oder alle Agenten) zugewiesen wurde. - Bitte verwenden Sie die Adresse des Rechenzentrums, in dem sich die Organisation befindet.
${endpoint}ist aus Organisationsliste abfragen das Rückgabe-Feldregionzu entnehmen (SG→sg,TH→th,JP→jp). Ein Aufruf eines anderen Rechenzentrums führt zu der Meldung „Nicht Mitglied dieser Organisation“.
Aufrufhäufigkeit
- Jeder Entwicklerschlüssel darf diese Schnittstelle maximal 60 Mal pro Minute aufrufen.
- Jeder Aufruf zählt gleichzeitig zum organisationsweiten Minutenkontingent für „statistische APIs“ und teilt dieses Kontingent mit den Aufrufen über den Agent-API-Schlüssel.
- Die Abfrageergebnisse werden 10 Minuten zwischengespeichert, empfohlen wird ein Aufruf pro Stunde.
Anfrage
Anfragebeispiel
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}'
Anfrage-Header
| Feld | Typ | Beschreibung |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Verwendet das Basic-Token nach DevKey:DevSecret Base64. |
Anfrageparameter
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| org_id | String | Ja | Organisations-ID. |
| agent_id | String | Ja | Agent-ID. Workflow wird nicht unterstützt. |
| start_time | Long | Ja | Startzeit, Millisekunden-Zeitstempel. Wird auf 0 Uhr desselben Tages gemäß Zeitzone der Organisation erweitert. |
| end_time | Long | Ja | Endzeit (exklusiv), Millisekunden-Zeitstempel. Nimmt den vorherigen Millisekunden-Zeitstempel des entsprechenden Kalendertages gemäß Zeitzone der Organisation als letzten Tag. Start- und Enddatum dürfen maximal 92 Tage umfassen. |
Antwort
Antwortbeispiel
{
"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
}
}
Erfolgreiche Antwort
| Feld | Typ | Beschreibung |
|---|---|---|
| agent_id | String | Argent Eddie. |
| timezone | String | Organisieren Sie Zeitzonen (UTC-Offsets, z. B. +08:00), geben Sie an, in welche Zeitzone das Datum eingeteilt wird. |
| range_start_date | String | Startdatum der tatsächlichen Statistik yyyy-MM-dd (Organisationszeitzone, einschließlich einschließlich). |
| range_end_date | String | Enddatum der tatsächlichen Statistiken yyyy-MM-dd (Organisationszeitzone, inklusive). |
| data_until | Long | Momente der Datenzählung (Millisekunden-Zeitstempel): Wenn das Intervall Echtzeitberechnungsdaten enthält, ist der Echtzeitteil der Berechnungszeit (Ergebnis bis zu 10 Minuten zwischengespeichert); Wenn das gesamte Intervall die täglichen Statistiken abgeschlossen hat, ist der Intervallendpunkt der Endpunkt. |
| conversation_count | Long | Anzahl der Gespräche im Intervall (täglich akkumuliert). |
| handoff_conversation_count | Long | Darunter ist die Anzahl der Sitzungen, die an menschliche Agenten übertragen werden, |
| handoff_rate | Number | Umrechnungsrate = handoff_conversation_count ÷ conversation_count, 0 zu 1, gerundet auf 4 Dezimalstellen; Wenn die Anzahl der Sitzungen 0 ist, ist sie null. |
Fehlerreaktion
| Feld | Typ | Beschreibung |
|---|---|---|
| code | Integer | Fehlercode. |
| message | String | Fehlerinformationen. |
Fehlercode
Der HTTP-Statuscode ist die ersten drei Bits des Fehlercodes, zum Beispiel 40000 für 400, 40100 für 401 und 403132 für 403.
| Fehlercode | Beschreibung |
|---|---|
| 40000 | Parameterfehler, wie fehlende erforderliche oder ungültige Parameter. |
| 40001 | Zu häufige Aufrufe: Dieser Entwicklerschlüssel hat das Minutenlimit für diese Schnittstelle überschritten. |
| 40008 | Das Minutenlimit des Organisationstarifs für „Statistik-APIs“ wurde überschritten. |
| 40010 | Schnittstelle vorübergehend geschlossen, bitte versuchen Sie es später erneut. |
| 40100 | Keine Berechtigung: Es fehlt die Berechtigung zur Einsicht der Nutzung oder es besteht keine Berechtigung zur Ansicht dieses Agenten (einschließlich Agent gehört nicht zu dieser Organisation). |
| 40105 | Kein Mitglied dieser Organisation oder Adresse eines anderen Rechenzentrums aufgerufen. |
| 40324 | DevKey oder DevSecret fehlerhaft. |
| 40378 | Agent wurde gelöscht. |
| 403132 | Ungültiger Zeitraum: Startzeit liegt nicht vor der Endzeit oder überschreitet den maximalen Abfragebereich. |
Statistikdefinitionen
- Anzahl der Sitzungen: Anzahl der Sitzungen, die an einem Tag Gespräche hatten, täglich kumuliert; fortlaufende Sitzungen über mehrere Tage werden an jedem Tag einzeln gezählt.
- Anzahl der auf menschliche Mitarbeiter übergeleiteten Sitzungen: Anzahl der Sitzungen, die an menschliche Mitarbeiter weitergeleitet wurden.
- Statistikbereich: Zählt nur die Kanäle des Entwicklungsraums, einschließlich API, Freigabeseite, Webseiten-Embedding, Bubble-Component, LiveDesk sowie alle Instant-Messaging- und Telefonkanäle; schließt die Nutzung von Agent nach Veröffentlichung im Workspace aus.
- Aktualisierungsfrequenz: Fertiggestellte tägliche Statistiken werden täglich ausgelesen; Echtzeitberechnung erfolgt für den aktuellen Tag. Die täglichen Statistiken werden nach Mitternacht der Zeitzone der Organisation durch die Statistikaufgabe erstellt. Vor Fertigstellung werden die Daten des Vortags in Echtzeit berechnet, sodass nach Mitternacht „gestern“ nicht null ist.
- Definition des Echtzeitbereichs: Zählung erfolgt nach der Zeit des letzten Gesprächs der Sitzung; fortlaufende Sitzungen über mehrere Tage werden im Echtzeitbereich nur einmal gezählt (am Tag des letzten Gesprächs), es können kleine Abweichungen zur täglich kumulierten Statistik auftreten.
