Saltar al contenido principal

Procesamiento de datos de SoSafe en PowerBI mediante Power Query M

Actualización

Introducción

Los clientes de SoSafe pueden recuperar datos analíticos/sin procesar directamente a través de la SoSafe API, que también puede utilizarse a través de PowerBI.

Esta guía muestra cómo utilizar Gen 2 Dataflows de Microsoft Fabric para recuperar y visualizar datos en PowerBI, con ejemplos basados en la información de la versión de navegador . Se explica cómo configurar consultas para una visualización eficiente de datos y su almacenamiento futuro mediante una plantilla proporcionada.

SoSafe PowerBI Template

¿Qué es?

La descarga está disponible al final de este artículo.

SoSafe ha creado una plantilla que puede importarse fácilmente en PowerBI para recuperar y visualizar datos de la SoSafe API. Esta plantilla incluye funcionalidades básicas para recuperar datos de la API, procesarlos y crear estructuras de tipo Table.

Diagrama de flujo de datos de Power Query que muestra los parámetros APIKey, KeyID y SoSafeHost alimentando las funciones performGetRequest y convertToTable, que producen las tablas Users, Campaigns y CampaignAnalytics.

La plantilla solo recupera datos dentro de un Gen 2 Dataflow y no contempla su uso posterior en informes de PowerBI ni en almacenes de datos.

Uso de la plantilla

  1. Cárguela directamente en PowerBI creando un nuevo flujo de datos y utilizando el archivo proporcionado anteriormente como modelo. Puede encontrar más información sobre cómo hacerlo en PowerBI aquí y aquí.

  2. Añada la API Key y el Key ID proporcionados a través del SoSafe Manager en los dos parámetros que ofrece la plantilla: APIKey y KeyID. Si aún no dispone de estos valores, consulte esta guía.

    Panel de parámetros de Power Query para introducir el valor de la API key, con una nota informativa que indica que es proporcionada por el SoSafe Manager. Debajo, una flecha señala el campo de valor actual, etiquetado como Valor atual, junto al botón Gerir parametro.

  3. Una vez añadidos ambos valores, puede hacer clic en las tablas correspondientes en el lado derecho del flujo de datos para cargarlas una a una y visualizar los datos:

Flujo de datos de Power Query con una información sobre herramientas en la tabla Campaigns que la describe como información y Analytics de campañas. Debajo, el script convertToTable y una vista previa de tabla con columnas para id, name, description, status, created y modulesplit.

  1. ¡Listo! Los datos están disponibles para que los visualice y procese.

Modificación de solicitudes base

La plantilla incluye tres tablas para tres tipos de datos que proporciona la SoSafe API:

Sin embargo, estos endpoints contienen distintos tipos de filtros de datos que pueden modificarse para obtener diferentes resultados de la API. Usando la tabla Users como ejemplo, podemos modificar la consulta.

  1. Haga clic derecho en la tarjeta de la tabla Users y comience a editar el script.

  2. Basándose en la documentación disponible en la especificación de la SoSafe Open API, añada los parámetros correspondientes de la siguiente manera y guarde el script.

    Script de Power Query para la tabla Users, con una anotación que señala el registro params donde se añade un parámetro limit a la llamada performGetRequest. Debajo, convertToTable define los campos firstname, lastname, email y userGroup.

  3. ¡Listo!

Adición de nuevas solicitudes

¡Añadir una nueva solicitud o tabla también es bastante sencillo! Antes de crear sus propias consultas, no olvide consultar la SoSafe Open API Spec para entender qué datos es posible recuperar de la API.

  1. Cree una nueva Blank Query y abra el editor de scripts.
  2. Dentro del bloque let, utilice la función performGetRequest para recuperar datos JSON.
  3. Aún dentro del bloque let, utilice el resultado de performGetRequest para recuperar la lista de registros y páselo como argumento a la función convertToTable para convertir los datos JSON en una tabla de Power Query.

  4. ¡Listo! Ahora podrá ver su nueva consulta junto a todas las demás.

Funciones personalizadas

La plantilla proporciona dos funciones personalizadas que pueden utilizarse en todo el flujo de trabajo para facilitar las tareas.

performGetRequest

Esta función llamará directamente a la SoSafe API y recuperará datos en formato JSON (los ejemplos de respuesta se pueden encontrar en la SoSafe Open API Spec). También gestionará la autenticación de forma automática, basándose en las credenciales proporcionadas en el primer paso, y añadirá Accept y Content-Type como encabezados predeterminados.

Además, performGetRequest también permite recuperar datos en fragmentos, utilizando múltiples solicitudes para obtener la totalidad del conjunto de datos en partes más pequeñas. Esto mejorará el rendimiento y ofrecerá mayor flexibilidad y control según sus necesidades. Por ejemplo, si se pasan chunkBy y chunkSize con los valores de ejemplo id y 5 respectivamente, y hay 15 valores en el parámetro de consulta id, esta función realizará 3 solicitudes y devolverá un array de 3 elementos con cada respuesta.

Esta función acepta dos argumentos:

  • path (text): La ruta de la solicitud GET, por ejemplo `/v1/users`
  • options (nullable record): Las Options que se transmiten en esta solicitud. Incluyen:
    • headers (record): Un registro clave/valor con todos los encabezados que se deben pasar, excluidos los predeterminados.
    • params (record): Un registro clave/valor con los parámetros que se añadirán a esta solicitud. Acepta valores de tipo text, number y list
    • chunkBy (text): El campo de texto por el que se fragmentarán los valores; debe proporcionarse junto con chunkSize y solo si el parámetro a fragmentar está presente en params
    • chunkSize (number): El número de registros que se solicitan a la vez a través de la API; debe proporcionarse junto con chunkBy

Ejemplo de solicitud con solicitudes fragmentadas:

responses = performGetRequest(
  "/v1/analytics/elearning",
  [
    params = [ campaignId = Table.Column(Campaigns, "id"),
    chunkBy = "campaignId",
    chunkSize = 5
  ]
),

convertToTable

Esta es una función sencilla que convierte una lista de registros en una tabla de Power Query. En el contexto de la SoSafe API, esto significa que los datos JSON de una respuesta recuperada con performGetRequest pueden utilizarse como argumento aquí. Además, acepta un argumento para determinar cuál es la clave primaria del conjunto de datos que se utilizará en la tabla, así como claves foráneas opcionales. Los argumentos son los siguientes:

  • records (list de records): La lista de registros que se convertirá en una tabla.
  • types (list de lists): Una lista con el nombre de los campos y sus respectivos tipos de Power Query. Esto convertirá los tipos de la respuesta en tipos de tabla adecuados. Por ejemplo:
    • {
  { "id", Int64.Type },
  { "name", Text.Type }
}
  • primaryKey(text): El nombre del campo que contiene la clave primaria de esta tabla.
  • foreignKey (nullable list): Una lista opcional que puede pasarse con todos los nombres de los campos que deben ser claves foráneas.

Ejemplo de conversión con solicitudes fragmentadas:

table = convertToTable(
  // convert all responses to a list of records containing the correct data
  List.Accumulate(
    responses,
    {},
    (acc, current) => List.Combine({ acc, current[data] })
  ),
  // assign types
  {
    { "customerId", Int64.Type },
    { "campaignId", Int64.Type },
    { "campaignName", Text.Type },
    { "firstname", Text.Type },
    { "lastname", Text.Type },
    { "email", Text.Type },
    { "language", Text.Type },
    { "userGroup", Text.Type },
    { "userCreated", Date.Type },
    { "registrationDate", Date.Type },
    { "isActive", Logical.Type },
    { "progress", Percentage.Type },
    { "achievedLevel", Percentage.Type },
    { "allPassed", Text.Type },
    { "passedModules", Int64.Type },
    { "overdueMandatoryModules", Int64.Type },
    { "passedMandatoryModules", Int64.Type },
    { "passedOptionalModules", Int64.Type },
    { "recentlyFinishedModule", Date.Type }
  },
  // assign primary key
  "email"
)

Esta traducción es automática. Si tienes dudas, consulta la versión en inglés.

Artículos relacionados