Extrair API

Criada por Suporte Bravo, Modificado em Wed, 01 Mar 2023 na (o) 11:01 AM por Isabelle Lemes

Disponível nos panos Freshdesk: Pro e Enterprise

Disponível nos planos Omnichannel: Pro e Enterprise



Recentemente, atualizamos nossa marca em nossas ofertas e mudamos os nomes de nossos planos de preços. Se você se inscreveu antes de 9 de agosto de 2021, clique em Planos anteriores para ver os planos aplicáveis.
 Garantimos que essa alteração não afetará sua experiência com o produto e nenhuma ação é necessária de sua parte.


Rastreie eventos importantes com APIs Extract do Freshdesk Messaging


Você pode obter mais do Freshdesk Messaging usando Extract APIs. Além dos relatórios no produto padrão, você pode baixar relatórios para várias outras métricas importantes e seus SLAs de suporte em minutos na forma de relatórios brutos personalizados usando APIs do Freshdesk Messaging Extract


Tipos de relatórios brutos


Existem 12 relatórios brutos diferentes que você pode baixar com a API Extract,

  1. Conversa Criada

  2. Agente de conversação atribuído

  3. Grupo de conversação atribuído

  4. Mensagem enviada

  5. Tempo de primeira resposta

  6. Tempo de resposta

  7. Tempo de resolução

  8. Etiqueta de resolução de conversa

  9. Conversa resolvida

  10. Atividade do Agente

  11. Atividade do agente Intelliassign

  12. Pontuação CSAT


Como fazer download de relatórios brutos usando a API de extração


Etapa 1: Acessando o endpoint da API


Substitua seu nome de domínio na API Endpoint


https: // <Domain Name> .freshchat.com / v2 / reports / raw /


Por exemplo,

Se o ponto de extremidade for https://mercasto.freshchat.com/v2/reports/raw/ , então 'Mercasto' é o nome do domínio.


Etapa 2: carga útil da API

Você deve passar o token do portador (token API) no cabeçalho.

Para saber como obter seu token de API, clique aqui


Post request


Esta é a carga útil a ser usada para a solicitação Get. Por exemplo, para obter a conversa criada entre 0h00 e 23h59 UTC, a carga útil será


 {

"start": "2020-09-03T00: 01: 00.000Z",

"fim": "2020-09-03T23: 59: 00.000Z",

"evento": "Conversa criada",

"format": "csv"

}


Nome do evento a ser usado na carga útil


Nome do evento de carga útil

Descrição

Criada por Conversa

Novas conversas criadas

Agente de conversação atribuído

Conversas atribuídas a um agente

Conversation-Group-Assigned

Conversas atribuídas a um grupo

Mensagem enviada

Mensagens enviadas por agentes

Primeiro tempo de resposta

Primeiro tempo de resposta das conversas

Tempo de resposta

Primeiro tempo de resposta de uma conversa

Tempo de resolução

Tempo de resolução de uma conversa

Conversation-Resolution-Label

Etiqueta de conversas resolvidas

Conversa resolvida

Conversas resolvidas

Agente-Atividade

Atividade do agente no Freshdesk Messaging

Agente-Intelliassign-Activity

Atividade do agente no Intelliassign

CSAT-Score

Pontuação CSAT

 

Obter pedido


Para processar a solicitação get, você terá que atualizar o ID do trabalho em sua API Endpoint.


 {

“Id”: “dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927”,

"link": {

“Rel”: “extrai”,

“Href”: “/ reports / raw / dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927”

}


Neste exemplo, “dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927” é o ID do trabalho e a API do endpoint será https://mercasto.freshchat.com/v2/reports/raw/ dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927


Depois que sua solicitação GET for processada, você pode baixar seu relatório a partir do URL do código que é retornado.


 {

"id": "dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927",

"status": "CONCLUÍDO",

"intervalo": "2020-09-14 00: 01: 00.0 2020-09-14 23: 59: 00.0",

"links": [

{

"link": {

"rel": "extração",

"Href": "https://csat-reports.s3-us-east-2.amazonaws.com/extraction/52a6f9sfd9sdf553d2c8bkjhkh896b5b1203afd250f6cb3LiKQkphA09ML%2F3gfsFOusBsdfdsg%fdhgfd&dgdfg2%2BvqB64CkVv2gQMzOxjSsmEqTI%2ByMS1T0UW3G8cOKmesDhaCredential=ASIA2RGYHGREDSFSDFUCOUYXCCZ24%2F20200915%2Fus-west-2%2Fs3%2Faws4_request&X -Amz-Signature = 2234e3f85d10c2d3ec434b5a97d5j8d83f6df4gf6b9f9f03d372e7026b9e3d699026abe0694730c0dd4 "

},

"de": "2020-09-14T00: 01: 00.000Z",

"para": "2020-09-14T23: 59: 00.000Z",

"status": "CONCLUÍDO"

}

]

}


Pontos importantes a serem observados:

  • Os relatórios brutos podem ser baixados apenas no formato CSV.

  • O fuso horário usado na carga útil deve ser UTC.

  • Pode levar até uma hora para que um relatório seja gerado.

  • Apenas uma solicitação POST pode ser processada por minuto.




Este artigo foi útil?

Que bom!

Obrigado pelo seu feedback

Desculpe! Não conseguimos ajudar você

Obrigado pelo seu feedback

Deixe-nos saber como podemos melhorar este artigo!

Selecione pelo menos um dos motivos
A verificação do CAPTCHA é obrigatória.

Feedback enviado

Agradecemos seu esforço e tentaremos corrigir o artigo