Observação: Esta API foi descontinuada e não oferecemos mais suporte para ela. Embora ainda esteja ativa, recomendamos enfaticamente que, para extrair os mesmos dados das sessões, utilize a API List Sessions disponível na documentação v2.0 da Botmaker.

Leitura estimada: 01 minuto

Objetivo:

Este serviço é usado para retornar métricas relacionadas às sessões em um determinado intervalo de tempo.

Parâmetros:

• dateISOFrom: Formato de data ISO. É usado como ponto de partida para retornar os registros.
• dateISOTo: Formato de data ISO. Ele é usado como um limite para retornar os registros.

Exemplo CURL:

curl -X GET --header 'Accept: application/json' --header 'dateISOFrom: 2020-01-01T00:00:00.000Z' --header 'dateISOTo: 2020-01-01T23:59:00.000Z' --header 'access-token: <ACCESS-TOKEN>' 'https://go.botmaker.com/api/v1.0/metrics'

Estrutura Resposta

• totalMsgByOp [number] Quantidade total de mensagens por operador | 35.
• totalSessions [number] Quantidade total de sessões| 10.
• totalUsers [number] Quantidade total de usuários | 7.
• byChannels [array] Lista de canais.
• totalSessionsHandleByBots [number] Quantidade total de sessões tratadas/atendidas pelo Bot | 2.
• totalSessionsHandleByOperators [number] Número total de sessões tratadas/atendidas pelos operadores | 10.
• totalMsgByBot [number] Quantidade total de mensagens por bot | 7.
• totalMsgByUser [number] Quantidade total de mensagens por usuário | 9.
• totalTopics [number] Quantidade total de temas/tópicos | 3.

Exemplo JSON:

{"totalMsgByOp":0,"totalSessions":0,"totalUsers":0,"byChannels":,"totalSessionsHandleByBots":0,"totalSessionsHandleByOperators":0,"totalMsgByBot":0,"totalMsgByUser":0,"totalTopics":0}

Escrito por: Equipe Botmaker

Atualizado: 09/02/2024