[POST] /metrics/v2/download

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 é utilizado para baixar as sessões e todas as informações relacionadas a elas. Cada chamada para este serviço retorna no máximo 200 registros e um page-token (tempo de vida/duração de 1 dia), para ser usado no endpoint: /download-page.

Importante: As informações serão enviadas apenas uma vez por dia.

Parâmetros:

• fromDate: Data que pode estar no formato ISO. É usado como ponto de partida para retornar os registros.O formato ISO irá deixar a data no seguinte modelo: 2024-02-14T07:00:00.000Z

Exemplo CURL:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'access-token: <ACCESS-TOKEN> 'https://go.botmaker.com/api/v1.0/metrics/v2/download?fromDate=2021-01-21T12%3A33%3A48'

Estrutura Resposta

• hasMore [boolean] Verifica se há mais | true.
• pageToken [string] Token de página | “48e2413a-0ef7-447a-b29f-4f3e59a8b546”.
• note [string] Nota | “Retrieving the data will take a little bit… Please use the ‘pageToken’ in the endpoint ‘/download-page’ to get the results.”.
• dateFrom [string] Data em formato ISO | “2021-01-21T12:33:48Z”.

Exemplo JSON:

{"hasMore":true,"pageToken":"48e2413a-0ef7-447a-b29f-4f3e59a8b546","note":"Retrieving the data will take a little bit... Please use the 'pageToken' in the endpoint '/download-page' to get the results.","dateFrom":"2021-01-21T12:33:48Z"}

Escrito por: Equipe Botmaker

Atualizado: 08/02/2024