Motimate : Comment générer des rapports à l'aide de l'API publique

Outre le partage des données relatives à l'achèvement des cours par l'intermédiaire de Motimate xAPInous prenons également en charge l'extraction de fichiers Excel à partir de l'API publique de Motimate. Ces rapports Excel sont basés sur des modèles de rapport qui ont été créés précédemment dans la section Générer des rapports sous Insights dans Motimate.

Voici quelques informations utiles avant de commencer :

Les trois fonctions pertinentes de l'API publique de Motimate sont les suivantes :

• GET /insights/learnings/report_templates
   
• POST /insights/learnings/report_requests
   
• GET /insights/learnings/report_requests/{id}

Avant de générer un rapport avec l'API publique, assurez-vous qu'un modèle de rapport a déjà été généré dans Générer des rapports(voir le guide ici) et que vous savez à partir de quel(s) modèle(s) vous allez générer le(s) rapport(s). Si tout est prêt, le processus de génération d'un rapport se déroulera en trois étapes :

Étape 1 : Obtenir une liste de modèles de rapports :

Commande : GET /insights/learnings/report_templates

Exemple de réponse :

{
  "data" : [
    {
      **"id" : "abc86b82-029a-4b74-9690-4ab607f3eafe "**,
      "name" : "Report Test",
      "description" : "Testing for Public API purpose",
      "last_status" : "uploading",
      "last_generated_at" : null,
      "created_at" : "2022-03-01T15:36:42.99789+01:00",
      "updated_at" : "2022-03-01T15:41:26.98349+01:00",
      "user" : {
        "name" : "John Doe"
      }
    }
  ]
}

Notez l'identifiant du modèle que vous devrez utiliser à l'étape suivante, dans ce cas : abc86b82-029a-4b74-9690-4ab607f3eafe

Étape 2 : Générer un nouveau rapport sur la base du modèle sélectionné

Commande : POST /insights/learnings/report_requests

Dans cet exemple, veillez à indiquer abc86b82-029a-4b74-9690-4ab607f3eafe comme template_id dans cette demande.

Exemple de réponse :

{
  "data" : {
    **"id" : "abc23922-940d-4d6d-a6f0-ecaed00810c4"**,
    "status" : "started",
    "created_at" : "2022-03-03T08:48:46.051Z",
    "updated_at" : "2022-03-03T08:48:46.051Z",
    "url" : null,
    "template" : {
      "id" : "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name" : "Report Test",
      "description" : "Testing for Public API purpose",
      "created_at" : "2022-03-01T15:36:42.99789+01:00",
      "updated_at" : "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Veuillez noter qu'une valeur pour url n'est pas encore disponible. En fonction de la quantité de données contenues dans le rapport, la génération d'un rapport peut prendre plusieurs minutes. Vous demanderez l'adresse URL de votre rapport à l'étape suivante.

Étape 3 : Obtenir l'URL du fichier de rapport Excel

Commande : GET /insights/learnings/report_requests/{id}

Veillez à utiliser l'identifiant des données dans la réponse de l'étape 2, et non l'identifiant du modèle!

Exemple de réponse :

{
  "data" : {
    "id" : "abc23922-940d-4d6d-a6f0-ecaed00810c4",
    "status" : "done",
    "created_at" : "2022-03-03T08:48:46.051Z",
    "updated_at" : "2022-03-03T08:48:46.839Z",
    **"url" : "<https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de>"**,
    "template" : {
      "id" : "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name" : "Report Test",
      "description" : "Testing for Public API purpose",
      "created_at" : "2022-03-01T15:36:42.99789+01:00",
      "updated_at" : "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Il se peut que vous deviez exécuter cette demande de manière récurrente toutes les 30 secondes jusqu'à ce que vous obteniez une réponse contenant une valeur pour l'url. Le temps nécessaire dépend de la quantité de données requises pour générer le rapport.

Dans cet exemple, l'url est https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx ?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de

En accédant à cette URL, vous téléchargerez vos rapports dans un fichier Excel .xlxs. Il n'est actuellement pas possible d'extraire les données dans d'autres formats de fichier, comme par exemple .csv.

Remarque : le fichier expirera au bout de 10 minutes et doit être téléchargé avant.

ℹ️ Si un modèle de rapport a été créé par un administrateur de groupe, qui n'a qu'un accès limité aux données des groupes et utilisateurs sélectionnés, cette restriction restera en vigueur lors de l'utilisation de l'API publique de Motimate.