Skip to main content
Mit der Reporting-API von Chatarmin CX verfolgst du Ticketvolumen, Antwortzeiten, Zufriedenheit und Automatisierung in deinen eigenen Dashboards.

Zugriff und Limits

Beide Endpoints erweitern die bestehende /public/v1-API. Sende deinen API-Schlüssel im Header cx-api-key. Der Schlüssel braucht analytics:read und muss einem Support-Agenten zugewiesen sein. Richte ihn unter Einstellungen → API ein. Berichtsabfragen beachten die Dashboard-Berechtigungen sowie Kanal-, Team- und Agenten-Einschränkungen dieses Agenten. Eine Metrik im Katalog gibt dir nicht automatisch Zugriff auf ihre Daten. Keiner der Endpoints verändert Tickets oder sendet Nachrichten. Unter Rate Limits findest du Hinweise zu Wiederholungen. Die OpenAPI-Referenz enthält die vollständigen Antwortschemas.

Metriken entdecken

Die Antwort ist { "success": true, "data": [...] }. Sie enthält den vollständigen statischen Katalog ohne Pagination. Jeder Eintrag hat folgende Felder: Der Katalog enthält keine Tickets, Kundendaten, Workspace-Entitäts-IDs oder internen Datenquellennamen. Namen und Beschreibungen sind auf Englisch. Cache diese Metadaten, statt sie vor jeder Abfrage neu zu laden. Nicht jede Metrik unterstützt jede Gruppierung oder Visualisierung.

Berichtsdaten abfragen

Starte mit einer Metrik und einem kurzen Zeitraum. Sende JSON mit genau zwei Feldern: query und einer IANA-Zeitzone in timezone, zum Beispiel Europe/Vienna oder UTC.
Die Antwort nutzt { "success": true, "data": ... }. Über data.kind erkennst du die Ergebnisform: kpi enthält zum Beispiel value, previousValue und format; time-series enthält series und points. Du erhältst Diagrammdaten, kein Bild und keinen CSV-Export.

Abfragesprache

Schreibe jede Klausel in eine eigene Zeile. Das ist die CX-Berichtsabfragesprache, kein SQL: Beliebige Tabellen, Joins und SQL-Ausdrücke sind nicht erlaubt. Gängige Visualisierungen sind kpi, line, area, grouped_bar, stacked_bar, horizontal_bar und data_table. Diagramme brauchen Metriken mit demselben format. Eine data_table darf Formate mischen und braucht genau eine Gruppierungsdimension. Alle Metriken, auch Automatisierung und CSAT, nutzen FROM tickets; es gibt keine separaten Nachrichten- oder Umfragedatensätze.

Abfragebeispiele

Sende jede vollständige Abfrage unten als query-String im HTTP-Request oben, mit timezone: "Europe/Vienna". Datumsangaben und Metrik-IDs behalten in allen Beispielen dasselbe Format.

Tägliches Ticketvolumen

Vergleiche erstellte und gelöste Tickets je Tag. Das sind unterschiedliche Ereignisgruppen, nicht unbedingt dieselben Tickets.

Ticket-KPI für gestern

Vergleiche neue Anfragen mit dem Vortag.

Neue Tickets nach Kanal

Sortiere Kanäle nach eingehendem Ticketvolumen. Kanalschlüssel im Ergebnis identifizieren die Kanäle deines Workspaces, keine allgemeingültige Liste von Kanalnamen.

Zeiten bis zur ersten Antwort

Vergleiche die mediane Wartezeit auf eine qualifizierende menschliche oder KI-Antwort mit der Wartezeit auf eine menschliche Antwort. Beide Reihen liefern Sekunden, keine Durchschnittswerte.

CSAT-Wert und Stichprobengröße

Zeige die Anzahl der Antworten neben dem Wert, damit du kleine Stichproben einschätzen kannst. Eine Tabelle erlaubt Dezimalwert und Anzahl in einem Ergebnis.

Einsparungen und KI-Ausgaben

Vergleiche geschätzte Einsparungen mit geschätzten Ausgaben in EUR. Dieses Tagesdiagramm nutzt dasselbe Format für beide Reihen und ist kein Rechnungsabgleich. Diese speziellen Automatisierungsmetriken unterstützen KPIs, tägliche Diagramme oder Tabellen sowie Aktionsaufteilungen, außer bei KI-Ausgaben. Mische sie nicht mit anderen Ticketmetriken und ergänze keine Kategorieaufteilungen.

Gefilterte Teamauslastung

Prüfe gelöste deutschsprachige Tickets nach Team, einschließlich Lösungsdauer. Mehrere Filter werden mit AND verknüpft. status ist der aktuelle Ticketstatus, nicht der Status bei Erstellung. Nutze für Filter wie team, channel oder human_agent die Entitäts-IDs deines Workspaces statt Anzeigenamen.

Aktuell auf Kunden wartende Tickets

Zähle offene Tickets, die auf Informationen vom Kunden warten, nicht Kunden, die auf den Support warten. Die Sprache verlangt eine Datumsklausel, aber diese macht einen Snapshot nicht zu historischen Daten. Ergänze bei Snapshots weder TIMESERIES noch COMPARE TO.

Ergebnisse lesen

Diese Antwortformen nutzen erfundene Beispielwerte, keine garantierten Ergebnisse für die Beispielzeiträume. Zeilen und Datenpunkte sind gekürzt. Nutze zurückgegebene Labels und Schlüssel, statt übersetzte Labels oder feste Kanal-IDs anzunehmen. Ein KPI liefert eine Zahl und ihr Format. previousValue kann null sein; historische KPIs können auch ohne expliziten Vergleich einen Vorperiodenwert enthalten. Mit COMPARE TO wählst du den Vergleichszeitraum ausdrücklich. Snapshot-KPIs haben keinen historischen Vergleich.
Werte in Zeitreihenpunkten nutzen die Schlüssel aus series. Explizite Vergleiche ergänzen Reihenschlüssel mit der Endung __compare.
Ein Kategorieergebnis enthält Werte mit Labels.
Eine Tabelle beschreibt Metrik und Format jeder Spalte. Addiere oder mittle keine täglichen Prozentsätze, Mediane oder Durchschnittswerte, um einen Zeitraum-KPI nachzubauen. Frage stattdessen den KPI für diesen Zeitraum ab.

Metrikreferenz

Unten stehen alle 50 registrierten Metrik-IDs, gruppiert wie im Katalog. Aggregation, Format und Zuordnung sind die exakten Katalogwerte. Du wählst die Metrik, keine eigene Aggregationsfunktion.
  • count zählt die definierten Tickets, Nachrichten, Umfragen, Aktionen oder Ereignisse; sum addiert Werte; average ist das arithmetische Mittel; median ist der mittlere Beobachtungswert; ratio teilt den passenden Zähler durch seinen Nenner.
  • duration-seconds liefert Sekunden, currency-eur EUR, decimal einen Dezimalwert und percent Prozentwerte: 75 bedeutet 75 %, nicht 0.75. CSAT-Werte nutzen eine Skala von 1 bis 5.
  • Die Zuordnung bestimmt den Datumsbezug: ticket_created ist eine Erstellungskohorte; ticket_resolved, reply_event, reopen_event, reassignment_event, survey_submitted, action_executed und order_paid beziehen sich auf das jeweilige Ereignis. agent_presence misst Online-Sitzungszeit; mixed_events kombiniert Erstellung und Lösung; current_snapshot bedeutet jetzt.
  • Werte einer Erstellungskohorte können sich mit den Tickets weiterentwickeln. Besonders messages und messages_per_ticket enthalten erfasste Nachrichten auf Tickets, die im Zeitraum erstellt wurden, nicht nur Nachrichten, die darin gesendet wurden. Für öffentliche menschliche Nachrichten mit Sendedatum im Zeitraum nutze agent_messages.
  • Aktuelle Snapshots erlauben keine Zeitdimensionen oder historischen Vergleiche. Das Alter offener Tickets zählt ab Erstellung, nicht ab der letzten Nachricht. Auch mit einer älteren Datumsklausel rekonstruiert ein Snapshot keinen Rückstand zum Periodenende.
  • Raten nutzen die Nenner in den Definitionen unten, innerhalb des jeweiligen Umfangs. Nullwerte oder leere Ergebnisse beweisen allein keine fehlende Aktivität: Berichtsdaten können unvollständig sein oder auf Aktualisierung warten. Prüfe wichtige Summen, bevor du sie für Zusagen oder Finanzberichte nutzt.
  • csat_response_rate ist eine Kohorte versendeter Umfragen: bewertete Einreichungen geteilt durch im Zeitraum versendete Umfragen. Im Katalog steht survey_submitted, aber diese Berechnung nutzt anders als die übrigen CSAT-Metriken das Versanddatum.
  • time_saved und money_saved sind Schätzungen aus den Aktionszeiten und dem Stundensatz deines Workspaces. ai_spend rechnet erfasste KI-Credits mit einem EUR-pro-Credit-Ersatzwert um; das ist weder deine Rechnung noch eine Garantie deines Vertragspreises. Obwohl im Katalog action_executed steht, zählt für Ausgaben das Erstellungsdatum des KI-Laufs, auch an Tagen ohne erfasste Aktionen.

Volumen und Auslastung

Antwort und Lösung

Qualität und Zufriedenheit

KI und Automatisierung

Fehlerbehebung

Zeitraumvalidierung, eine geschätzte Aufwandsprüfung und Limits für zurückgegebene Zeilen oder Punkte garantieren weder eine allgemeine maximale Laufzeit noch eine Grenze für jede Ergebniszelle oder zugrunde liegende Datenbankoperation. LIMIT kürzt zurückgegebene Zeilen oder Punkte; es ist keine Pagination und garantiert nicht weniger Datenbankarbeit. Teile große Reporting-Aufgaben in kleinere Zeitfenster. Historische Vollständigkeit und Aktualität hängen von den verfügbaren Berichtsdaten ab; eine erfolgreiche Antwort bestätigt beides nicht. Scheitert eine gültige kleine Abfrage oder wirken Summen unvollständig, kontaktiere den Support mit der request_id aus der Antwort, der Zeitzone und einer bereinigten Abfrage. Teile niemals deinen API-Schlüssel.