Passer au contenu principal

Métriques de reporting pour REST API et exportations CSV

Métriques de reporting pouvant être calculées à l'aide de notre REST API et des exportations CSV.

Écrit par Jacob Cox

Cet article couvre les métriques de reporting pouvant être calculées à l'aide de la REST API d'Intercom et des exportations CSV. Utilisez-le pour créer des rapports personnalisés à partir des données brutes de l'API, résoudre les écarts entre le tableau de bord de votre espace de travail et les exportations CSV, ou comprendre comment les métriques se répartissent entre les différents systèmes de reporting d'Intercom. Cet article s'adresse aux développeurs et analystes de données qui accèdent aux données de conversation Intercom de manière programmatique ou via une exportation en masse.

Toutes les métriques ne peuvent pas être calculées via la REST API, car certaines données ne sont pas incluses dans les points de terminaison de l'API. Vérifiez votre plan Intercom pour confirmer que l'accès à la REST API et les exportations CSV sont disponibles dans votre abonnement.

Définitions et termes importants :

  • Partie visible de la conversation = Partie de la conversation visible par le client.

  • Partie de conversation administrateur humain = Partie de la conversation créée par un coéquipier. Exclut les parties créées par les automatisations simples (le bot basé sur des règles d'Intercom), les bots Facebook et GitHub.

  • Toutes les durées sont en secondes.

  • Les durées dans l'API excluent les heures de bureau.

  • Les durées dans Elasticsearch qui excluent les heures de bureau ont un suffixe _ooo.


Métriques REST API

Les tableaux suivants listent les métriques REST API disponibles sur le point de terminaison des conversations Intercom. Utilisez-les pour créer des rapports personnalisés ou interroger les données de conversation de manière programmatique.

Horodatages

first_contact_reply_at

Horodatage du plus ancien des événements de contact suivants. Tous les autres horodatages de cette section sont mesurés par rapport à cette valeur :

  • Une partie de conversation textuelle d'un utilisateur

  • Une partie collectée d'attribut

  • Un UserMessage (un message initié par le client)

first_assignment_at

Horodatage de la première partie de conversation d'assignation après first_contact_reply_at

first_admin_reply_at

Horodatage de la première partie visible de conversation administrateur humain après first_contact_reply_at

first_close_at

Horodatage de la première partie de conversation de fermeture après first_contact_reply_at

last_assignment_at

Horodatage de la dernière partie de conversation d'assignation après first_contact_reply_at

last_assignment_admin_reply_at

Horodatage de la dernière partie de conversation d'assignation après first_contact_reply_at et avant first_admin_reply_at

last_contact_reply_at

Horodatage du plus récent des événements de contact suivants :

  • Une partie de conversation textuelle d'un utilisateur

  • Une partie collectée d'attribut

  • Un UserMessage (un message initié par le client)

last_admin_reply_at

Horodatage de la dernière partie visible de conversation administrateur humain après first_contact_reply_at

last_close_at

Horodatage de la dernière partie de conversation de fermeture après first_contact_reply_at

count_reopens

Nombre de réouvertures après first_contact_reply_at

count_assignments

Nombre d'assignations après first_contact_reply_at

count_conversation_parts

Nombre total de parties de conversation

Les durées suivantes sont toutes exprimées en secondes et excluent les heures de bureau. Ce sont des champs REST API sur l'objet conversation.

Durées

time_to_assignment

time_to_admin_reply

time_to_first_close

time_to_last_close

reply_times

Liste des temps de réponse pour une conversation. Un temps de réponse est la différence de temps entre une partie visible de conversation administrateur humain et la partie visible précédente si cette partie a été créée par le client.


Les sections suivantes listent les métriques équivalentes disponibles dans les pipelines de reporting Elasticsearch d'Intercom. Elasticsearch est le magasin de données qui alimente les graphiques de reporting intégrés d'Intercom. Lorsqu'une métrique est définie comme « Identique à [métrique API] », le calcul est identique — seul le nom du champ diffère.

Elasticsearch est le magasin de données qui alimente les graphiques de reporting intégrés d'Intercom. Intercom maintient deux pipelines Elasticsearch — un pipeline plus récent utilisé par les fonctionnalités de reporting actuelles et un pipeline hérité utilisé par les anciens graphiques. Les sections ci-dessous listent les noms de champs Elasticsearch équivalents pour les métriques REST API définies ci-dessus. Lorsqu'un champ est défini comme « Identique à [champ API] », le calcul sous-jacent est identique — seul le nom du champ diffère.

Elasticsearch - pipeline récent

Ce sont les champs d'horodatage du pipeline récent Elasticsearch. Ils correspondent directement aux horodatages REST API ci-dessus et alimentent les graphiques de reporting actuels dans votre espace de travail.

Horodatages

started_at

Identique à first_contact_reply_at (REST API) — horodatage de la première partie de conversation textuelle d'un utilisateur, partie collectée d'attribut ou UserMessage.

first_response_at

Identique à first_admin_reply_at (REST API) — horodatage de la première partie visible de conversation administrateur humain après first_contact_reply_at.

last_closed_at

Identique à last_close_at (REST API) — horodatage de la dernière partie de conversation de fermeture après first_contact_reply_at.

last_closed_by_human_at

Horodatage de la dernière partie de conversation de fermeture par un humain après started_at

Ce sont les champs de durée du pipeline récent Elasticsearch, exprimés en secondes. Ils correspondent aux métriques de durée REST API ci-dessus.

Durées

time_to_last_close

Identique à time_to_last_close (REST API) — durée de first_contact_reply_at à last_close_at, en secondes.

time_to_last_close_by_human

first_response_time

Identique à time_to_admin_reply (REST API) — durée de first_contact_reply_at à first_admin_reply_at, en secondes.


Elasticsearch - pipeline hérité

Nouvelles conversations entrantes

Le graphique « Nouvelles conversations entrantes » dans vos rapports Intercom affiche les données des conversations liées aux messages UserMessage (conversations initiées par un client). La période sélectionnée s'applique à l'horodatage created_at de la conversation, pas à celui du fil de messages created_at.


Export CSV

L'export CSV télécharge les données liées aux fils de messages dans la période sélectionnée. Il inclut toutes les conversations de tous types de messages, ce qui le rend plus large que les graphiques de reporting individuels dans votre espace de travail.

Par exemple, le graphique « Nouvelles conversations entrantes » dans les rapports Intercom affiche uniquement les conversations liées à un type de message UserMessage, tandis que l'export CSV inclut les conversations liées à tous les types de messages. C'est pourquoi les totaux dans l'export CSV peuvent ne pas correspondre aux chiffres des graphiques individuels.

Important : Comparer les résultats de l'export CSV avec les graphiques du tableau de bord de votre espace de travail peut ne pas donner les mêmes résultats car l'horodatage created_at du fil de messages n'est pas le même que celui de la conversation created_at.


Exemples

Les scénarios suivants illustrent comment les métriques de reporting sont calculées selon différentes chronologies de conversation. Chaque scénario montre comment les horodatages et durées sont appliqués selon le moment où les événements se produisent dans une conversation.

Scénario 1 : Cycle unique d'ouverture-fermeture

Scénario 1 : un exemple de chronologie montrant comment first_contact_reply_at, first_admin_reply_at et les horodatages associés sont calculés pour une conversation simple avec un cycle unique d'ouverture-fermeture.

Diagramme de chronologie montrant comment first_contact_reply_at, first_admin_reply_at, first_close_at et les horodatages associés sont calculés pour une conversation avec un cycle unique d'ouverture-fermeture.

Scénario 2 : Conversation rouverte après fermeture

Scénario 2 : un exemple de chronologie montrant comment les métriques sont calculées lorsqu'une conversation est rouverte après avoir été fermée, affectant last_close_at, count_reopens et time_to_last_close.

Diagramme de chronologie montrant comment last_close_at, count_reopens et time_to_last_close sont calculés lorsqu'une conversation est rouverte après fermeture.

Scénario 3 : Multiples assignations et réponses administrateur

Scénario 3 : un exemple de chronologie montrant comment les métriques sont calculées lorsqu'il y a plusieurs assignations et réponses administrateur avant la fermeture de la conversation, affectant time_to_assignment et last_assignment_admin_reply_at.

Diagramme de chronologie montrant comment time_to_assignment et last_assignment_admin_reply_at sont calculés lorsqu'il y a plusieurs assignations et réponses administrateur avant la fermeture de la conversation.
Avez-vous trouvé la réponse à votre question ?