Descarga de estadísticas mediante API

Estas instrucciones van dirigidas a personas con un mínimo conocimiento de lenguaje de programación web:  JAVASCRIPT.  Si no es tu caso, recomendamos que te pongas en contacto con tus desarrolladores y les facilites estas instrucciones. La instalación será muy fácil para ellos. 

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.

LIMITACIONES

Por razones de rendimiento, el uso de este api, está limitado a una petición por minuto. No se pueden conusltar fechas anteriores al último año y la consulta no puede superar un máximo de 31 dias.

Los datos descargados no contienen los datos de la conversación. Son solo datos de duracion, estado, etc, de la sesion. En ningun caso, la descarga contiene la transcripción del chat en sí.

Ejemplo de peticion:

1. https://[OCT8NE-SERVER-HERE]/apidata/export/v2/sessions/[FORMAT]?apiToken=[YOUR- APIKEY-HERE]&domainId=[YOUR-DOMAIN-ID]&startTime=[DATE]&endTime=[DATE]&utcOffset=[UTC_OFFSET]

 La variable [OCT8NE-STATIC-SERVER-HERE] hace referencia al servidor de Oct8ne en el que está dado de alta. Oct8ne trabaja con distintos servidores, en USA y en EU.

Una vez dentro del panel de control de Oct8ne, observe la dirección (url) del navegador:

Si es del tipo ‘backoffice.oct8ne.com’, le corresponde el servidor USA.

Si por el contrario es ‘backoffice-eu.oct8ne.com’, le corresponde el servidor EU.

El valor de la variable en función del servidor es

En EU,  [OCT8NE-STATIC-SERVER-HERE] → static-eu.oct8ne.com

En USA,  [OCT8NE-STATIC-SERVER-HERE] → static.oct8ne.com

Los datos pueden ser obtenidos en formato CSV o JSON. Por tanto, la variable [FORMAT] puede ser el valor 'csv o 'json', en función del formato que desees exportar.

Respecto a los parámetros de la petición:

apiToken: Clave de seguridad del dominio que es proporcionada por el equipo técnico.  [YOUR- APIKEY-HERE] 

domainId: Identificador del dominio que es proporcionado por el equipo técnico. [YOUR-DOMAIN-ID]

startTime:  Fecha de inicio de las sesiones a exportar. El Formato debe ser mm/dd/yyyy  [DATE]

endTime: 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. [DATE]

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

agentFilter:  Opcional. Id del agente por el que deseamos filtrar los datos. Por defecto se muestran todos los agentes.

deptFilter:  Opcional. Id del departamento. Por defecto se muestran todos los departamentos.

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

1: Sesiones que han sido atendidas por un agente.

2: Sesiones en las que el visitante ha pedido ayuda (valor por defecto).

3: Sesiones en las que el visitante ha pedido ayuda, pero no fue atendido.

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

0: formato de hora (hh:mm:ss)

1: total de segundos

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

0: Todas las sesiones, independientemente si se ha registrado o no venta. (valor por defecto).

1: Sesiones en las que se ha registrado venta.

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.

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

0: Todas las sesiones, independientemente si el agente es Bot o Humano. (valor por defecto).

1: Sesiones en las que el agente es Humano

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 final de petición GET (formato json ):

1. https://backoffice-eu.oct8ne.com/apidata/export/v2/sessions/json?apiToken=AAAF80D2A39A53A2899175156FE5E6799&domainId=1234&startTime=01/01/2020&endTime=01/15/20200&utcOffset=1&attentionFilter=2

Si no dispones de la infomacion de apitoken y domainId, ponte en contacto con contact@oct8ne.com y en breve te proporcionarán los datos que te corresponden

---

También se pueden descargar los contactos generados en Oct8ne. En este caso, la petición cambia y la ruta apunta a 'leads'.

Ejemplo de peticion:

1. https://[OCT8NE-SERVER HERE]/apidata/export/v2/leads/[FORMAT]?apiToken=[YOUR- APIKEY HERE]&domainId=[YOUR-DOMAIN-ID]&startTime=[DATE]&endTime=[DATE]&utcOffset=[UTC_OFFSET] 
   

* Los parámetro son los mismos, salvo que en este endpoint no se acceptan filtros opcionales.

Ejemplo final de petición GET (formato json ):

1. https://backoffice-eu.oct8ne.com/apidata/export/v2/leads/json?apiToken=AAAF80D2A39A53A2899175156FE5E6799&domainId=1234&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 ...

• Cancelación de un número de WhatsApp Business API (Waba)

  Este documento describe el proceso de cancelación, los diferentes estados por los que pasa el número tanto en el hub de 360 Dialog como lo que puede continuar haciendo o no, el cliente desde que solicitamos la baja de un número hasta que es efectiva. ...

• Pixel de ventas (script)

  Estas instrucciones van dirigidas a personas con un mínimo conocimiento de lenguaje de programación web: HTML y JAVASCRIPT. Si no es tu caso, recomendamos que te pongas en contacto con tus desarrolladores y les facilites estas instrucciones. La ...

• Integra Oct8ne con tu APP mobile (mediante webviews)

  Estas instrucciones van dirigidas a personas con un mínimo conocimiento de lenguaje de programación web: HTML y JAVASCRIPT . Si no es tu caso, recomendamos que te pongas en contacto con tus desarrolladores y les facilites estas instrucciones. La ...