InicioContactar a soporte
Actualizado: 8/8/2024

[POST] /metrics/v2/download

[POST] /metrics/download-page


Objetivo:

Usar este servicio para descargar la página de sesiones y toda la información relacionada que se infiera de la misma. Cada llamada a este servicio retorna un máximo de 1000 registros y un token (tiempo de vida de un día).

Se recomienda usar el list-session de la versión 2. https://api.botmaker.com/v2.0/#/operations/list-sessions


Parámetros:

  • pageToken: Token de página, se obtiene en metrics/download.


Ejemplo 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/download-page?pageToken=2fb2085a-e5d8-4000-88d7-6380bb475db7'


Estructura de la respuesta

  • fromDate [timestamp] Fecha en la que se generó la primera sesión de la lista | 2021-01-01T00:00:00.001Z.
  • pageRows [number] Cantidad de columnas de página | 21.
  • sessions [array] Lista de sesiones.
    • variables [array] Lista de variables.
      • varKey:varValue [type] Variables que tenga activa la sesión | “botmakerenvironment😀EVELOPMENT”.
    • sessionDate [timestamp] Fecha en la que se generó la sesión | “2021-01-20T13:56:59.184Z”
    • botMessages [number] Mensajes del bot | 23.
    • userHasTalked [boolean] Verifica si el usuario habló | “true”
    • topics [array] Lista de temas
      • topicKey [string] Temas con los cuales interactuó en la sesión “Identidad”.
    • sessionId [string] Id de la sesión | “YPU6L8F1SA7Y8SHSVH17_2021-01-20T13:56:59.184Z”.
    • platformContactId [string] Id de plataforma | “SBBZ2F73DL-5572714M6YG3Y5V2S0DO1L3QZMD”.
    • userCreationTime [timestamp] Fecha en el que se generó el usuario por primera vez | “2021-01-01T00:00:00.001Z”.
    • sessionMessages [array] Lista de mensajes de sesión
      • creationTime [timestamp] Fecha del momento en que se creó el mensaje | “2021-01-20T15:03:30.535Z”.
      • messageId [string] ID del mensaje para identificarlo de manera unívoca | “83T21XKVJGQ1EZ1L1NCH”.
      • messageType [string] Tipo del mensaje | “Text”.
      • message [string] Mensaje | “test”.
      • msgFrom [string] De dónde viene el mensaje | “user”.
      • imagesUrls [string] URL del storage de Botmaker donde se almacenó la imagen | “null”.
      • audiosUrls [string] URL del storage de Botmaker donde se almacenó el audio | “null”.
      • videosUrls [string] URL del storage de Botmaker donde se almacenó el video | “null”.
      • filesUrls [string] URL del storage de Botmaker donde se almacenó el archivo | “null”.
      • ruleName [string] Nombre de la intención que se ejecutó | “Compras a domicilio”.
      • operator [string] Nombre del operador que interactuó | “Nicolás V.”
      • queue [string] Nombre de la cola de atención con la que interactuó | “Test_Botmaker”.
    • customerId [string] ID del cliente para identificarlo de manera unívoca | “YPU6L8F1SA7Y8SHSVH17”.
    • userMessages [number] Cantidad de mensajes del usuario | 23.
    • operatorMessages [number] Cantidad de mensajes del agente | 2.
    • sessionMessagesQty [number] Cantidad de mensajes de la sesión | 46.
    • sessionStartingCause [string] Causa del inicio de sesión | “Organic”.
    • channelId [string] Id del canal | “testbot-webchat-null-SBBZ2F73DL”.
    • conversation [string] URL de las conversaciones | “https://go.botmaker.com/#/chats/YPU6L8F1SA7Y8SHSVH17”.
    • events [array] Lista de eventos
      • eventName [string] Nombre del evento | “put-var”.
      • eventCreationTime [timestamp] Fecha de creación del evento | “2021-01-20T14:49:09.701Z”.
      • info [array] [
        • name [string] Nombre | “key”.
        • value [string] Valor | “test@botmaker.io-1498255647287”.
  • toDate [timestamp] Tiempo en la que se generó la última sesión de la lista | 2021-01-01T00:00:00.001Z.
  • hasMore [boolean] Verifica si tiene más | true.
  • totalRows [number] Número total de columnas | 200.



Ejemplo JSON:

{"pageRows":21,"sessions":[{"variables":["botmakerenvironment😀EVELOPMENT","webchathostdomain:go.botmaker.com","webchathosthref:https://go.botmaker.com/#/home","webid:SBBZ2F73DL","webchatcountry:AR","webchathostpagetitle:botmaker","webchathostreferrer:https://go.botmaker.com/","ipaddress:170.51.100.220","lastrulebuilder:testbot:FIRST_MESSAGE","nombre:test","webchathosturi:https://go.botmaker.com/#/home","webchathosturl:https://go.botmaker.com/#/home"],"sessionDate":"2021-01-20T13:56:59.184Z","botMessages":23,"userHasTalked":"true","topics":["Identidad"],"sessionId":"YPU6L8F1SA7Y8SHSVH17_2021-01-20T13:56:59.184Z","platformContactId":"SBBZ2F73DL-5572714M6YG3Y5V2S0DO1L3QZMD","sessionMessages":[{"creationTime":"2021-01-20T15:03:30.535Z","messageType":"Text","message":"test","msgFrom":"user","imagesUrls":null,"audiosUrls":null,"videosUrls":null,"filesUrls":null,"ruleName":null,"operator":null,"queue":null}],"customerId":"YPU6L8F1SA7Y8SHSVH17","userMessages":23,"operatorMessages":0,"sessionMessagesQty":46,"sessionStartingCause":"Organic","channelId":"testbot-webchat-null-SBBZ2F73DL","conversation":"https://go.botmaker.com/#/chats/YPU6L8F1SA7Y8SHSVH17","events":[{"eventName":"put-var","eventCreationTime":"2021-01-20T14:49:09.701Z","info":[{"name":"key","value":"test@botmaker.io-1498255647287"}]}]}],"hasMore":false,"totalRows":21}