Descarga de estadísticas mediante API

Descarga de estadísticas mediante API


Oct8ne permite descargar la información de todas las sesiones almacenadas en la plataforma con objeto de facilitar el tratamiento externo de los datos.

Para ello, se deberá realizar una petición hacia los servidores de Oct8ne con una clave de seguridad y un identificador que proporcionará nuestro equipo técnico. En dicha petición es posible aplicar un rango de fechas, que no debe superar un máximo de 31 días ni consultar fechas anteriores al último año, así como algunos criterios de filtro adicionales.


Notes
Los datos pueden ser obtenidos en formato CSV o JSON.



URL

https://[OCT8NE-SERVER-HERE]/apidata/export/v2/sessions/[FORMAT]?apiToken=[YOUR- APIKEY-HERE]&domainId=[YOUR-DOMAIN-

ID]&startTime=[DATE]&endTime=[DATE]&utcOffset=[UTC_OFFSET]


Parámetros de entrada

[FORMAT]

Formato en el que se obtendrán los datos

  1. csv
  2. json

apiToken

Clave de seguridad del dominio que es proporcionada por el equipo técnico.

domainId

Id del dominio que es proporcionado por el equipo técnico

startTime

Requerido. Fecha de inicio de las sesiones a exportar. El Formato debe ser mm/dd/yyyy

endTime

Requerido. Fecha de fin de las sesiones a exportar. El formato debe ser mm/dd/yyyy y no puede superar los 31 días desde la fecha de inicio.

agentFilter

Id del agente por el que deseamos filtrar los datos. Campo opcional; por defecto se muestran todos los agentes.

deptFilter

Id del departamento. Campo opcional; por defecto se muestran todos los departamentos.

attentionFilter

Valor numérico que indica el filtro a aplicar según el estado de la atención al usuario en la sesión:

  1. 1: Sesiones que han sido atendidas por un agente.
  2. 2: Sesiones en las que el visitante ha pedido ayuda (valor por defecto).
  3. 3: Sesiones en las que el visitante ha pedido ayuda, pero no fue atendido.

utcOffset

Diferencia horaria local respecto a UTC+0, en horas (por ejemplo, si estamos en UTC+1, el valor sería 1)

sale

Campo opcional: Valor numérico que indica el filtro a aplicar según si en la sesión se ha registrado una venta: 

  1. 0: Todas las sesiones, independientemente si se ha registrado o no venta.
  2. 1: Sesiones en las que se ha registrado venta.
  3. 2: Sesiones en las que no se ha registrado venta.


Si no se envía este campo, se descargarán todas las sesiones, independientemente si se ha registrado o no venta.


durationFormat

Campo opcional: Valor numérico que indica el formato de los campos de duración. Valor por defecto 0.

  1. 0: formato de hora (hh:mm:ss)
  2. 1: total de segundos

agentType

Campo opcional: Valor numérico que indica el filtro a aplicar según si el último que atendió es Humano o es el Bot:

  1. 0: Todas las sesiones, independientemente si el agente es Bot o Humano
  2. 1: Sesiones en las que el agente es Humano
  3. 2: Sesiones en las que el agente es Bot.


Si no se envía este campo, se descargarán todas las sesiones, independientemente del tipo de agente.


Ejemplo de petición

GET https://backoffice-eu.oct8ne.com/apidata/export/v2/sessions/csv

?apiToken=AAAF80D2A39A53A2899175156FE5E67

&domainId=123 &startTime=01/01/2020 &endTime=01/15/2020 &utcOffset=1

&attentionFilter=2


GET https://backoffice-eu.oct8ne.com/apidata/export/v2/sessions/json

?apiToken=AAAF80D2A39A53A2899175156FE5E67

&domainId=123 &startTime=01/01/2020 &endTime=01/15/2020 &utcOffset=1

&attentionFilter=2




NotesTambién se pueden descargar los contactos generados en Oct8ne 


URL

https://[OCT8NE-SERVER-HERE]/apidata/export/v2/leads/[FORMAT]?apiToken=[YOUR- APIKEY-HERE]&domainId=[YOUR-DOMAIN-

ID]&startTime=[DATE]&endTime=[DATE]&utcOffset=[UTC_OFFSET]


Parámetros de entrada

[FORMAT]

Formato en el que se obtendrán los datos

  1. csv
  2. json

apiToken

Clave de seguridad del dominio que es proporcionada por el equipo técnico.

domainId

Id del dominio que es proporcionado por el equipo técnico

startTime

Requerido. Fecha de inicio de las sesiones a exportar. El Formato debe ser mm/dd/yyyy y debe estar

endTime

Requerido. Fecha de fin de las sesiones a exportar. El formato debe ser mm/dd/yyyy y no puede superar los 31 días desde la fecha de inicio.

utcOffset

Diferencia horaria local respecto a UTC+0, en horas (por ejemplo, si estamos en UTC+1, el valor sería 1)

Ejemplo de petición

GET https://backoffice-eu.oct8ne.com/apidata/export/v2/leads/csv

?apiToken=AAAF80D2A39A53A2899175156FE5E67

&domainId=123 &startTime=01/01/2020 &endTime=01/15/2020 &utcOffset=1


GET https://backoffice-eu.oct8ne.com/apidata/export/v2/leads/json

?apiToken=AAAF80D2A39A53A2899175156FE5E67

&domainId=123 &startTime=01/01/2020 &endTime=01/15/2020 &utcOffset=1





    • Related Articles

    • API Oct8ne de integración con CSM a medida

      Documentación del API Oct8ne Versión del API 2.4 (Octubre 2024 / rev05) Índice de contenidos 1. Introducción 2. Arquitectura 3. Vista general 3.1. Descargar e instalar plugin/extensión 3.2. Registro como desarrollador y activación de la plataforma ...

    • API envíos transaccionales o masivos desde Whatsapp

      Introducción WhatsApp Delivery API permite automatizar el envío de plantillas WhatsApp a través de Oct8ne. Las operaciones disponibles son las siguientes: Enviar plantilla a WhatsApp Consultar estado del envío Consultar resumen de envíos Consultar ...

    • Carga de catálogo mediante Feed

      1. INTRODUCCIÓN Una de las principales características de Oct8ne es su visor integrado. El visor es un espacio interactivo que comparten los agentes y los clientes, dentro del chat, para poder visualizar imágenes y vídeos de los productos de tu ...

    • Manual de instrucciones del Bot para web y messaging

      TABLA DE CONTENIDO 1. VISIÓN GENERAL 1.1. El diseñador de conversaciones 2. BOT WEB: PRIMEROS PASOS 2.1. Crear una conversación 2.2. Herramientas específicas en el diseñador de conversaciones 2.3. Encender y apagar el Bot 3. BOT MESSAGING: PRIMEROS ...

    • Cómo obtener una clave (token) de API de OpenAI

      1.- Ve a la página web de la Plataforma de OpenAI en platform.openai.com e inicia sesión con una cuenta de OpenAI. 2.- Ya en tu perfil (puedes comprobarl en la esquina superior izquierda), haz clic en el apartado ‘Dashboard’ en la esquina superior ...