Organisatorische Nutzungsübersicht abrufen

Rufen Sie die Gesamtsumme der Punktverbrauche, neuen Sitzungen und Benutzeranfragen einer Organisation innerhalb eines bestimmten Zeitraums ab und blättern Sie nach Agent / Workflow. Mit einem einzigen Aufruf können Sie die Daten aller Agenten der Organisation abrufen, es ist nicht erforderlich, jeden Agenten einzeln aufzurufen.

Hinweis: Es können maximal Daten für 31 Tage abgefragt werden; es werden nur Entwicklungsspaces gezählt, der genaue Abdeckungsbereich ist unten unter „Statistische Kriterien“ aufgeführt.

Anfragemethode

GET

Aufrufadresse

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

Authentifizierung

Verwenden Sie die 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 (Organisation Owner oder Administratoren haben standardmäßig diese Berechtigung).
• Bitte rufen Sie die Adresse des Rechenzentrums auf, in dem sich die Organisation befindet. ${endpoint} entnehmen Sie aus der Rückgabe von Organisationsliste abfragen für region (SG → sg, TH → th, JP → jp). Ein Aufruf eines anderen Rechenzentrums führt zu „Nicht Mitglied dieser Organisation“.

Aufrufhäufigkeit

• Jeder Entwickler-Schlüssel kann diese Schnittstelle maximal 60 Mal pro Minute aufrufen.
• Jeder Aufruf wird gleichzeitig auf das Minutenkontingent der Organisation für „statistische APIs“ angerechnet und teilt dieses Kontingent mit den statistischen API-Aufrufen des Agent API Keys.
• Abfragen, die das heutige oder gestrige Datum enthalten, werden 5 Minuten zwischengespeichert; Ergebnisse älterer Daten werden 1 Stunde zwischengespeichert. Es wird empfohlen, die Abfrage alle 5 bis 15 Minuten durchzuführen.

Anfrage

Anfragebeispiel

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/summary?org_id=${org_id}&start_time=1792425600000&end_time=1795017600000&page=1&page_size=20' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    

Anfrage-Header

Anfrageparameter

Antwort

Antwortbeispiel

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "org_id": "65f0c2a1b4e8d93a1c7e5b20",
        "timezone": "+07:00",
        "range_start_date": "2026-10-16",
        "range_end_date": "2026-11-14",
        "data_since": "2026-10-15",
        "data_until": 1794614400000,
        "total": {
            "credits": 1234.5678,
            "unattributed_credits": 36.2011,
            "conversation_count": 5210,
            "message_count": 48213
        },
        "agents": {
            "page": 1,
            "page_size": 20,
            "total": 86,
            "list": [
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                    "name": "客服助手",
                    "agent_type": "AGENT",
                    "credits": 402.1200,
                    "conversation_count": 2104,
                    "message_count": 19820
                },
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                    "name": "订单查询",
                    "agent_type": "WORKFLOW",
                    "credits": 130.5000,
                    "conversation_count": null,
                    "message_count": null
                }
            ]
        }
    }
}

                    

Erfolgreiche Antwort

Fehlgeschlagene Antwort

Fehlercodes

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

Statistikkriterien

• Statistikbereich: Es werden nur Entwicklerbereiche gezählt, einschließlich API, Freigabeseiten, Web-Einbettungen, Bubble-Komponenten, LiveDesk sowie aller Instant-Messaging- und Telefonkanäle sowie der Workflows des Entwicklerbereichs; die Nutzung von Arbeitsbereichen (GWork) sowie der in Arbeitsbereichen genutzten veröffentlichten Agenten wird nicht eingeschlossen.
• Credits: Alle Verbrauchsarten (ohne Punkteablauf und Abonnementzahlungen). Der Verbrauch durch Workflows wird dem jeweiligen Workflow zugeschrieben, der durch einen Agenten aufgerufen wird, verursachte Verbrauchswerte werden diesem Agenten nicht zugerechnet. Punktedaten sind ab dem Funktionsstartdatum (data_since) verfügbar, historische Daten werden nicht nachgetragen.
• Sitzungsanzahl: Anzahl der im Zeitraum neu erstellten und bereits geführten Sitzungen, ohne Entwickler-Bereich-Debugging-Vorschau. Workflow-Ausführungen erzeugen keine Sitzungen; AI-Suchen in Arbeitsbereichen zählen nicht. Sitzungszahl und Fragezahl sind ab 31 Tage vor Funktionsstart verfügbar.
• Frageanzahl: Anzahl der vom Nutzer im Zeitraum gesendeten Fragen, Antworten der AI sind nicht eingeschlossen.
• Sortierung: agents.list ist nach Punkten absteigend sortiert; bei gleichen Punkten nach der Anzahl der Sitzungen. Agenten ohne Credits, Sitzungen oder Fragen im Zeitraum werden nicht aufgeführt.
• Aktualisierungshäufigkeit: Credits werden in Echtzeit aktualisiert; Sitzungsanzahl und Fragezahl werden stündlich zur vollen Stunde gezählt, mit etwa 1 Stunde Verzögerung.