Passar para o conteúdo principal

Métricas de relatórios para REST API e exportações CSV

Métricas de relatórios que podem ser calculadas usando nossa REST API e exportações CSV.

Escrito por Jacob Cox

Este artigo aborda métricas de relatórios que podem ser calculadas usando a REST API e exportações CSV da Intercom. Use-o para criar relatórios personalizados a partir de dados brutos da API, solucionar discrepâncias entre o painel do seu workspace e as exportações CSV, ou entender como as métricas se relacionam nos diferentes sistemas de relatórios da Intercom. Este artigo é destinado a desenvolvedores e analistas de dados que acessam dados de conversas da Intercom programaticamente ou via exportação em massa.
​
Nem todas as métricas podem ser calculadas via REST API, pois alguns dados não estão incluídos nos endpoints da API. Verifique seu plano Intercom para confirmar se o acesso à REST API e as exportações CSV estão disponíveis na sua assinatura.

Definições e termos importantes:

  • Parte visível da conversa = Parte da conversa que é visível para o cliente.

  • Parte da conversa de administrador humano = Parte da conversa criada por um colega de equipe. Exclui partes criadas por automações simples (bot baseado em regras da Intercom), bots do Facebook e GitHub.

  • Todas as durações estão em segundos.

  • As durações na API excluem o horário comercial.

  • As durações no Elasticsearch que excluem o horário comercial têm o sufixo _ooo.


Métricas da REST API

As tabelas a seguir listam as métricas da REST API disponíveis no endpoint de conversas da Intercom. Use-as para criar relatórios personalizados ou consultar dados de conversas programaticamente.

Carimbos de data/hora

first_contact_reply_at

Carimbo de data/hora para o evento de contato mais antigo a seguir. Todos os outros carimbos de data/hora nesta seção são medidos em relação a este valor:

  • Uma parte de conversa de texto de um usuário

  • Uma parte coletada de atributo

  • Uma UserMessage (uma mensagem iniciada pelo cliente)

first_assignment_at

Carimbo de data/hora da primeira parte da conversa de atribuição após first_contact_reply_at

first_admin_reply_at

Carimbo de data/hora da primeira parte visível da conversa de administrador humano após first_contact_reply_at

first_close_at

Carimbo de data/hora da primeira parte da conversa de fechamento após first_contact_reply_at

last_assignment_at

Carimbo de data/hora da última parte da conversa de atribuição após first_contact_reply_at

last_assignment_admin_reply_at

Carimbo de data/hora da última parte da conversa de atribuição após first_contact_reply_at e antes de first_admin_reply_at

last_contact_reply_at

Carimbo de data/hora para o evento de contato mais recente a seguir:

  • Uma parte de conversa de texto de um usuário

  • Uma parte coletada de atributo

  • Uma UserMessage (uma mensagem iniciada pelo cliente)

last_admin_reply_at

Carimbo de data/hora da última parte visível da conversa de administrador humano após first_contact_reply_at

last_close_at

Carimbo de data/hora da última parte da conversa de fechamento após first_contact_reply_at

count_reopens

Número de reaberturas após first_contact_reply_at

count_assignments

Número de atribuições após first_contact_reply_at

count_conversation_parts

Número total de partes da conversa

As durações a seguir são todas expressas em segundos e excluem o horário comercial. Estes são campos da REST API no objeto conversa.

Durações

time_to_assignment

time_to_admin_reply

time_to_first_close

time_to_last_close

reply_times

Lista de tempos de resposta para uma conversa. Um tempo de resposta é a diferença de tempo entre uma parte visível da conversa de administrador humano e a parte visível anterior da conversa, se essa parte foi criada pelo cliente.


As seções a seguir listam métricas equivalentes disponíveis nos pipelines de relatórios Elasticsearch da Intercom. Elasticsearch é o armazenamento de dados que alimenta os gráficos de relatórios integrados da Intercom. Quando uma métrica é definida como 'Igual a [métrica da API]', o cálculo é idêntico — apenas o nome do campo difere.

Elasticsearch é o armazenamento de dados que alimenta os gráficos de relatórios integrados da Intercom. A Intercom mantém dois pipelines Elasticsearch — um pipeline mais novo usado pelos recursos atuais de relatórios e um pipeline legado usado por gráficos antigos. As seções abaixo listam os nomes equivalentes dos campos Elasticsearch para as métricas da REST API definidas acima. Quando um campo é definido como 'Igual a [campo da API]', o cálculo subjacente é idêntico — apenas o nome do campo difere.

Elasticsearch - pipeline novo

Estes são campos de carimbo de data/hora do pipeline novo do Elasticsearch. Eles correspondem diretamente aos carimbos de data/hora da REST API acima e alimentam os gráficos de relatórios atuais no seu workspace.

Carimbos de data/hora

started_at

Igual a first_contact_reply_at (REST API) — carimbo de data/hora para a parte de conversa de texto mais antiga de um usuário, parte coletada de atributo ou UserMessage.

first_response_at

Igual a first_admin_reply_at (REST API) — carimbo de data/hora da primeira parte visível da conversa de administrador humano após first_contact_reply_at.

last_closed_at

Igual a last_close_at (REST API) — carimbo de data/hora da última parte da conversa de fechamento após first_contact_reply_at.

last_closed_by_human_at

Carimbo de data/hora da última parte da conversa de fechamento feita por um humano após started_at

Estes são campos de duração do pipeline novo do Elasticsearch, expressos em segundos. Eles correspondem às métricas de duração da REST API acima.

Durações

time_to_last_close

Igual a time_to_last_close (REST API) — duração de first_contact_reply_at até last_close_at, em segundos.

time_to_last_close_by_human

first_response_time

Igual a time_to_admin_reply (REST API) — duração de first_contact_reply_at até first_admin_reply_at, em segundos.


Elasticsearch - pipeline legado

Novas conversas recebidas

O gráfico 'Novas conversas recebidas' nos seus Relatórios Intercom mostra dados para conversas vinculadas a mensagens UserMessage (conversas iniciadas por um cliente). O período selecionado é aplicado ao carimbo de data/hora created_at da conversa, não ao carimbo de data/hora created_at do thread da mensagem.


Exportação CSV

A exportação CSV baixa dados vinculados aos threads de mensagens no período selecionado. Inclui todas as conversas de todos os tipos de mensagem, tornando-a mais abrangente do que gráficos de relatórios individuais no seu workspace.

Por exemplo, o gráfico 'Novas conversas recebidas' nos Relatórios Intercom mostra apenas conversas vinculadas a um tipo de mensagem UserMessage, enquanto a exportação CSV inclui conversas vinculadas a todos os tipos de mensagem. Por isso, os totais na exportação CSV podem não corresponder aos números dos gráficos individuais.

Importante: Comparar os resultados da exportação CSV com os gráficos do painel do seu workspace pode não gerar os mesmos resultados, pois o carimbo de data/hora created_at do thread da mensagem não é o mesmo que o created_at da conversa.


Exemplos

Os cenários a seguir ilustram como as métricas de relatórios são calculadas em diferentes linhas do tempo de conversas. Cada cenário mostra como carimbos de data/hora e durações são aplicados dependendo de quando os eventos ocorrem em uma conversa.

Cenário 1: Ciclo único de abertura e fechamento

Cenário 1: um exemplo de linha do tempo mostrando como first_contact_reply_at, first_admin_reply_at e carimbos de data/hora relacionados são calculados para uma conversa simples com um único ciclo de abertura e fechamento.

Diagrama da linha do tempo mostrando como first_contact_reply_at, first_admin_reply_at, first_close_at e carimbos de data/hora relacionados são calculados para uma conversa com um único ciclo de abertura e fechamento.

Cenário 2: Conversa reaberta após fechamento

Cenário 2: um exemplo de linha do tempo mostrando como as métricas são calculadas quando uma conversa é reaberta após ser fechada, afetando last_close_at, count_reopens e time_to_last_close.

Diagrama da linha do tempo mostrando como last_close_at, count_reopens e time_to_last_close são calculados quando uma conversa é reaberta após ser fechada.

Cenário 3: Múltiplas atribuições e respostas de administrador

Cenário 3: um exemplo de linha do tempo mostrando como as métricas são calculadas quando há múltiplas atribuições e respostas de administrador antes da conversa ser fechada, afetando time_to_assignment e last_assignment_admin_reply_at.

Diagrama da linha do tempo mostrando como time_to_assignment e last_assignment_admin_reply_at são calculados quando há múltiplas atribuições e respostas de administrador antes da conversa ser fechada.
Respondeu à sua pergunta?