La API de Buzzmonitor está actualmente disponible de forma gratuita, lo que permite migrar ciertos tipos de datos a otras plataformas. Esta integración debe ser realizada por su equipo, ya que no ofrecemos soporte para este proceso, que es independiente del software adquirido. Podemos responder a dudas relacionadas con el proceso a través de preguntas enviadas por correo electrónico para nuestro equipo de tecnología.
1. VISIÓN GENERAL
Buzzmonitor dispone de una API para la extracción de datos.
La API permite obtener datos de monitoreo, que son básicamente los datos de las gráficas e interacciones disponibles en los informes del módulo de Monitorización.
La API no permite la inserción de datos, es decir, no será posible responder a una interacción, aplicar una etiqueta, crear un ticket, ocultar una interacción, a través de la API.
2. PRIMEROS PASOS
2.1 ¿Qué se necesita para realizar una llamada a la API?
Para realizar llamadas a la API se debe utilizar el método POST, un Endpoint y una Payload.
2.2 ¿Cuáles son los Endpoints?
- posts.json: Se utiliza para obtener datos de las interacciones. En este endpoint es posible obtener hasta 10.000 interacciones, pero hasta 5.000 por llamada. La paginación debe realizarse utilizando los parámetros "size" y "offset".
- scroll.json: Se utiliza para obtener grandes cantidades de datos de interacción. En este endpoint es posible obtener un número ilimitado de interacciones, pero hasta 5.000 por llamada. La paginación debe realizarse utilizando los parámetros “size” y “scroll_id”. El "scroll_id" se devolverá después de la primera llamada. La siguiente llamada debe realizarse dentro de los próximos 60 segundos.
- volume.json: utilizado para obtener los datos de los gráficos.
2.3 Cómo obtener el Payload:
Debe crearse un informe que devuelva las interacciones que se desean obtener a través de la API. Este informe deberá enviarse al equipo de CS, indicando si se desean obtener los datos del gráfico o las interacciones, para que el Payload sea generado.
¡Los parámetros del Payload podrán ser ajustados!
3. EJEMPLOS DE LLAMADA
3.1 Postman
Seleccionar el método POST;
Insertar la URL del Endpoint;
En Body > raw > insertar el Payload enviado por el equipo de Customer Success.
4. DUDAS MÁS FRECUENTES
4.1 ¿Cómo obtener los datos que son exhibidos en Analytics?
Actualmente, los datos de Analytics no se devuelven a través de API. Solo se devuelven datos de Monitorización.
4.2 ¿Cómo debe ser realizada la autenticación?
Os parâmetros de autenticação estão contidos no Payload gerado, no campo de “authentication_params”.
4.3 ¿Hay limitación de llamadas a la API?
Actualmente, existe un límite de 100 llamadas por minuto.
4.4 ¿Cómo alterar el periodo en el Payload?
El período puede ser modificado a través de los campos "since" y "until". Estos campos deben tener el siguiente formato:
- YYYYMMDDhhmmss
Ejemplo: obtener datos para el periodo de 01/07/2023 00:00:00 hasta 31/07/2023 23:59:59:
- since: 20230701000000
- until: 20230731235959
4.5 ¿Cómo obtener todas las interacciones de un ticket?
Para ese retorno se debe utilizar el endpoint de “posts.json”.
En el Payload, dentro del campo de “general_params”, deberá ser enviado el siguiente campo:
“all_ticket_posts”: true
4.6 ¿Cómo retornar interacciones o tickets por fecha de modificación?
Para ese retorno se debe utilizar el endpoint de “posts.json”.
En el Payload, dentro del campo “general_params”, se debe enviar el siguiente campo:
“apply_update_periodo”: true
5. LINKS IMPORTANTES
5.1 Documentación:
posts.json/scroll.json:https://help.buzzmonitor.com.br/wp-content/uploads/2021/06/Buzzmonitor_API_Posts.pdf