Exportar datos de widget del dashboard
Introducción
La explicacion de este tutorial tiene como objetivo demostrar como extraer o exportar los datos analiticos renderizados por un widget de dashboard de academia.
Pasos a seguir
Tener acceso con un usuario administrador de la academia
Ir a "Dashboard" y crear los widgets:
Widget tabla de usuarios
Widget engagement de cursos
Extraer el ID del dashboard y de los Widgets desde la consola web (tenemos pensado mejorar esto para poder copiar la URL sencillamente desde un botón)
Crear una API KEY para realizar las peticiones: link al tutorial
Endpoint https://api.go4clic.com/institutions/<INSTITUTION_SLUG>/dashboards/<ID_DASHBOARD>/widgets/<ID_WIDGET>/action/
Payload
{
"action": "export",
"format": "json",
"from": null,
"to": null,
"limit": 10,
"offset": 0,
"comparators": [
{
"id": 1,
"filters": {
"users": {},
"courses": {}
},
"color": "#1a73e8"
}
]
}
En el payload se puede filtrar por ID de usuarios o ID de cursos. Si no se especifica te trae todo.
IMPORTANTE: utilizar los parámetros "offset" y "limit" sino la API les va a retornar un timeout.
Headers
x-api-key: <API_KEY>