Zum Hauptinhalt springen

Berichtmetriken für REST API und CSV-Exporte

Berichtmetriken, die mit unserer REST API und CSV-Exporten berechnet werden können.

Verfasst von Jacob Cox

Dieser Artikel behandelt Berichtmetriken, die mit Intercoms REST API und CSV-Exporten berechnet werden können. Verwenden Sie ihn, um benutzerdefinierte Berichte aus rohen API-Daten zu erstellen, Diskrepanzen zwischen Ihrem Workspace-Dashboard und CSV-Exporten zu beheben oder zu verstehen, wie Metriken in Intercoms verschiedenen Berichtssystemen abgebildet werden. Dieser Artikel richtet sich an Entwickler und Datenanalysten, die programmgesteuert oder über den Massenexport auf Intercom-Konversationsdaten zugreifen.

Nicht alle Metriken können über die REST API berechnet werden, da einige Daten in den API-Endpunkten nicht enthalten sind. Überprüfen Sie Ihren Intercom-Plan, um zu bestätigen, dass REST API-Zugriff und CSV-Exporte in Ihrem Abonnement verfügbar sind.

Wichtige Definitionen und Begriffe:

  • Sichtbarer Gesprächsteil = Gesprächsteil, der für den Kunden sichtbar ist.

  • Menschlicher Admin-Gesprächsteil = Gesprächsteil, der von einem Teammitglied erstellt wurde. Schließt Teile aus, die von Simple Automations (Intercoms regelbasiertem Bot), Facebook- und GitHub-Bots erstellt wurden.

  • Alle Zeitdauern sind in Sekunden angegeben.

  • Die Zeitdauern in der API schließen Bürozeiten aus.

  • Die Zeitdauern in Elasticsearch, die Bürozeiten ausschließen, haben das Suffix _ooo.


REST API-Metriken

Die folgenden Tabellen listen REST API-Metriken auf, die am Intercom-Konversationsendpunkt verfügbar sind. Verwenden Sie diese, um benutzerdefinierte Berichte zu erstellen oder Konversationsdaten programmgesteuert abzufragen.

Zeitstempel

first_contact_reply_at

Zeitstempel für das früheste der folgenden Kontakt-Ereignisse. Alle anderen Zeitstempel in diesem Abschnitt werden relativ zu diesem Wert gemessen:

  • Ein Textgesprächsteil von einem Benutzer

  • Ein Attribut-erfasster Teil

  • Eine UserMessage (eine vom Kunden initiierte Nachricht)

first_assignment_at

Zeitstempel des ersten zugewiesenen Gesprächsteils nach first_contact_reply_at

first_admin_reply_at

Zeitstempel des ersten sichtbaren menschlichen Admin-Gesprächsteils nach first_contact_reply_at

first_close_at

Zeitstempel des ersten geschlossenen Gesprächsteils nach first_contact_reply_at

last_assignment_at

Zeitstempel des letzten zugewiesenen Gesprächsteils nach first_contact_reply_at

last_assignment_admin_reply_at

Zeitstempel des letzten zugewiesenen Gesprächsteils nach first_contact_reply_at und vor first_admin_reply_at

last_contact_reply_at

Zeitstempel für das späteste der folgenden Kontakt-Ereignisse:

  • Ein Textgesprächsteil von einem Benutzer

  • Ein Attribut-erfasster Teil

  • Eine UserMessage (eine vom Kunden initiierte Nachricht)

last_admin_reply_at

Zeitstempel des letzten sichtbaren menschlichen Admin-Gesprächsteils nach first_contact_reply_at

last_close_at

Zeitstempel des letzten geschlossenen Gesprächsteils nach first_contact_reply_at

count_reopens

Anzahl der Wiederöffnungen nach first_contact_reply_at

count_assignments

Anzahl der Zuweisungen nach first_contact_reply_at

count_conversation_parts

Gesamtanzahl der Gesprächsteile

Die folgenden Zeitdauern sind alle in Sekunden angegeben und schließen Bürozeiten aus. Dies sind REST API-Felder im Gesprächsobjekt.

Dauern

time_to_assignment

time_to_admin_reply

time_to_first_close

time_to_last_close

Antwortzeiten

Liste der Antwortzeiten für ein Gespräch. Eine Antwortzeit ist die Zeitdifferenz zwischen einem sichtbaren menschlichen Admin-Gesprächsteil und dem vorherigen sichtbaren Gesprächsteil, wenn dieser Teil vom Kunden erstellt wurde.


Die folgenden Abschnitte listen äquivalente Metriken auf, die in Intercoms Elasticsearch-Berichtspipelines verfügbar sind. Elasticsearch ist der Datenspeicher, der die integrierten Berichtscharts von Intercom antreibt. Wo eine Metrik als ‚Gleich wie [API-Metrik]‘ definiert ist, ist die Berechnung identisch – nur der Feldname unterscheidet sich.

Elasticsearch ist der Datenspeicher, der die integrierten Berichtscharts von Intercom antreibt. Intercom unterhält zwei Elasticsearch-Pipelines – eine neuere Pipeline, die von aktuellen Berichtsfunktionen verwendet wird, und eine Legacy-Pipeline, die von älteren Charts genutzt wird. Die folgenden Abschnitte listen die entsprechenden Elasticsearch-Feldnamen für die oben definierten REST API-Metriken auf. Wo ein Feld als ‚Gleich wie [API-Feld]‘ definiert ist, ist die zugrunde liegende Berechnung identisch – nur der Feldname unterscheidet sich.

Elasticsearch - neue Pipeline

Dies sind Elasticsearch-Felder für Zeitstempel der neuen Pipeline. Sie entsprechen direkt den oben genannten REST API-Zeitstempeln und treiben die aktuellen Berichtscharts in Ihrem Workspace an.

Zeitstempel

started_at

Gleich wie first_contact_reply_at (REST API) – Zeitstempel für den frühesten Textgesprächsteil von einem Benutzer, Attribut-erfassten Teil oder UserMessage.

first_response_at

Gleich wie first_admin_reply_at (REST API) – Zeitstempel des ersten sichtbaren menschlichen Admin-Gesprächsteils nach first_contact_reply_at.

last_closed_at

Gleich wie last_close_at (REST API) – Zeitstempel des letzten geschlossenen Gesprächsteils nach first_contact_reply_at.

last_closed_by_human_at

Zeitstempel des letzten geschlossenen Gesprächsteils durch einen Menschen nach started_at

Dies sind Elasticsearch-Dauerfelder der neuen Pipeline, angegeben in Sekunden. Sie entsprechen den oben genannten REST API-Dauer-Metriken.

Dauern

time_to_last_close

Gleich wie time_to_last_close (REST API) – Dauer von first_contact_reply_at bis last_close_at in Sekunden.

time_to_last_close_by_human

first_response_time

Gleich wie time_to_admin_reply (REST API) – Dauer von first_contact_reply_at bis first_admin_reply_at in Sekunden.


Elasticsearch - Legacy-Pipeline

Neue eingehende Gespräche

Das Diagramm „Neue eingehende Gespräche“ in Ihren Intercom-Berichten zeigt Daten für Gespräche, die mit UserMessage-Nachrichten verknüpft sind (von einem Kunden initiierte Gespräche). Der ausgewählte Zeitraum wird auf den Zeitstempel created_at des Gesprächs angewendet, nicht auf den Zeitstempel created_at des Nachrichten-Threads.


CSV-Export

Der CSV-Export lädt Daten herunter, die mit den Nachrichtenthreads im ausgewählten Zeitraum verknüpft sind. Er umfasst alle Gespräche aller Nachrichtentypen und ist damit umfassender als einzelne Berichtscharts in Ihrem Workspace.

Beispielsweise zeigt das Diagramm „Neue eingehende Gespräche“ in Intercom-Berichten nur Gespräche, die mit einem Nachrichtentyp UserMessage verknüpft sind, während der CSV-Export Gespräche aller Nachrichtentypen einschließt. Deshalb können die Gesamtsummen im CSV-Export von den einzelnen Diagrammwerten abweichen.

Wichtig: Der Vergleich der CSV-Export-Ergebnisse mit Ihren Workspace-Dashboard-Diagrammen kann zu unterschiedlichen Ergebnissen führen, da der Zeitstempel created_at des Nachrichtenthreads nicht mit dem Zeitstempel created_at des Gesprächs übereinstimmt.


Beispiele

Die folgenden Szenarien veranschaulichen, wie Berichtmetriken über verschiedene Gesprächszeitlinien berechnet werden. Jedes Szenario zeigt, wie Zeitstempel und Zeitdauern angewendet werden, abhängig davon, wann Ereignisse in einem Gespräch auftreten.

Szenario 1: Einzelner Öffnen-Schließen-Zyklus

Szenario 1: Ein Zeitlinienbeispiel, das zeigt, wie first_contact_reply_at, first_admin_reply_at und verwandte Zeitstempel für ein einfaches Gespräch mit einem einzelnen Öffnen-Schließen-Zyklus berechnet werden.

Zeitliniendiagramm, das zeigt, wie first_contact_reply_at, first_admin_reply_at, first_close_at und verwandte Zeitstempel für ein Gespräch mit einem einzelnen Öffnen-Schließen-Zyklus berechnet werden.

Szenario 2: Gespräch nach dem Schließen wieder geöffnet

Szenario 2: Ein Zeitlinienbeispiel, das zeigt, wie Metriken berechnet werden, wenn ein Gespräch nach dem Schließen wieder geöffnet wird, was last_close_at, count_reopens und time_to_last_close beeinflusst.

Zeitliniendiagramm, das zeigt, wie last_close_at, count_reopens und time_to_last_close berechnet werden, wenn ein Gespräch nach dem Schließen wieder geöffnet wird.

Szenario 3: Mehrere Zuweisungen und Admin-Antworten

Szenario 3: Ein Zeitlinienbeispiel, das zeigt, wie Metriken berechnet werden, wenn es mehrere Zuweisungen und Admin-Antworten gibt, bevor das Gespräch geschlossen wird, was time_to_assignment und last_assignment_admin_reply_at beeinflusst.

Zeitliniendiagramm, das zeigt, wie time_to_assignment und last_assignment_admin_reply_at berechnet werden, wenn es mehrere Zuweisungen und Admin-Antworten gibt, bevor das Gespräch geschlossen wird.
Hat dies deine Frage beantwortet?