Acceso requerido: Analytics y API token
Dificultad: ¡Solo para desarrolladores!
Los widgets de tipo tabla de Borealis son la mejor manera de organizar los datos para prepararlos en la integración con otro sistema de su organización. Por ejemplo, es posible que desee:
- Obtener la lista de quejas de este mes con el nivel de riesgo
- Obtener la lista de nuevos grupos de interés con sus respectivas direcciones de correo electrónico
- Proporcionar estadísticas del uso de datos para fines de informes globales
Cómo capturar los datos de un widget de tipo tabla
- Asegúrese de que tiene un token de API válido. Esto debe ser proporcionado por su superusuario.
- Busque el widget a partir del cual desea capturar los datos. Puede hacerlo a través de la interfaz web o la documentación de la API (https://COMPANY.boreal-is.com/api-docs/YOUR_INSTANCE/).
- Nota: Si no está utilizando un paquete corporativo, COMPANY y YOUR_INSTANCE deben ser los mismos valores.
- Si lo encontró utilizando la interfaz Web, la URL del widget contendrá el ID del widget. Por ejemplo, la URL: https://COMPANY.boreal-is.com/YOUR_INSTANCE/analytics/widgets/table#254 es para el ID del widget 254
- Una vez que tenga el ID, puede hacer su primera prueba. A continuación encontrará un comando curl como ejemplo para capturar los datos.
Ejemplo de código
curl -X GET "https://COMPANY.boreal-is.com/api/YOUR_INSTANCE/analytics/widgets/254?offset=0&limit=10" -H "accept: application/json" -H "api_key: MY_TOKEN"
Tengo muchos datos, ¿qué hago?
Si el widget contiene muchos datos, es posible que deba realizar varias llamadas para obtener todos los datos. Observe en las llamadas previas los siguientes parámetros:
- offset=0
- limit=10
Esto significa que la llamada le devolverá un máximo de 10 resultados, empezando por el primero. Si usted sabe que el widget dará más resultados eventualmente, tiene dos opciones.
- Haga que el parámetro de límite sea más grande (el valor más alto aceptado es 1000)
- Si usted tiene más datos que esto, tendrá que ejecutar varias llamadas
- offset=0&limit=1000 --Obtener los primeros 1000 resultados
- offset=1000&limit=1000 --Obtener resultados 1001 a 2000
- Y así sucesivamente hasta que el número de resultados devueltos sea menor que el límite establecido.