Rapports sur l’API

Planfix propose deux manières de récupérer les données de rapports via l'API REST :

Vous pouvez créer un rapport programmé et récupérer ses données via le REST API.
Déclencher la génération du rapport via le REST API et récupérer les données dès qu'elles sont prêtes.

Vous pouvez trouver la spécification complète de l'API REST ici.

Récupération des données d'un rapport programmé via l'API REST

Créer un jeton d'autorisation pour l'employé à qui vous prévoyez d'envoyer le rapport. Les données enregistrées du rapport ne seront disponibles qu'aux employés que vous aurez choisis pour l'envoi. Pour créer un jeton, allez dans Gestion du compte — Accès à l'API — REST API — Créer un nouveau jeton:
- Dans le champ Employé / Contact, spécifiez l'employé qui recevra le rapport programmé.
- Dans le champ Scopes autorisés, saisissez : report_readonly.

Récupérer la liste des rapports via l'API REST en utilisant la méthode /report/list et trouver l'ID du rapport requis dans la réponse (vous pouvez trouver l'ID du rapport dans la barre d'adresse du navigateur).

Récupérer la liste des versions enregistrées du rapport sélectionné en utilisant la méthode /report/{id}/save/list.

Récupérer les données du rapport par l'ID de la nouvelle version en utilisant la méthode /report/{id}/save/{saveId}/data.

Les données de rapport enregistrées ne sont disponibles que pour les employés que vous sélectionnez pour l'envoi.
Si le rapport est volumineux, la version comportera plusieurs parties (chunks). Lors de la récupération des données du rapport, vous devez indiquer l'index du chunk pour obtenir tous les morceaux. Avec la méthode /report/[id]/save/list, vous pouvez déterminer le nombre de chunks dans le rapport.

Créer un jeton d'autorisation pour l'employé à qui vous prévoyez d'envoyer le rapport. Les données enregistrées du rapport ne seront disponibles qu'aux employés que vous aurez choisis pour l'envoi. Pour créer un jeton, allez dans Gestion du compte — Accès à l'API — REST API — Créer un nouveau jeton:
- Dans le champ Employé / Contact, spécifiez l'employé qui recevra le rapport programmé.
- Dans le champ Scopes autorisés, saisissez : report_readonly.

Déclencher la génération du rapport en utilisant l'endpoint /report/{id}/generate. La réponse retournera un requestId.

Après un court délai, vérifier le statut du rapport avec /report/status/{requestId}.

La réponse inclura un objet ReportSave (même format que pour les rapports programmés) si le rapport est prêt.

Récupérer les données du rapport par l'ID de la version enregistrée en utilisant la méthode /report/{id}/save/{saveId}/data.

Disponible uniquement sur le plan de tarification Corporate.
Les rapports ne peuvent être générés qu'au maximum toutes les 10 minutes.
Un seul rapport peut être généré à la fois par compte.
Les rapports sont générés au nom de l'utilisateur associé au jeton API, et ses permissions d'accès s'appliquent.