Vue d’ensemble
Pour vous éviter de devoir générer et envoyer manuellement les rapports de dashboards, la commande d’API ScheduledReport fournit un ensemble d’endpoints qui envoient automatiquement vos rapports de dashboards selon l’intervalle indiqué, qui peut être quotidien, hebdomadaire, mensuel, trimestriel ou annuel. Cette commande vous permet aussi d’indiquer qui doit recevoir le rapport, par quel canal et dans quel format.
Exemples d’utilisation
L’API ScheduledReport vous permet de :
- Créer, récupérer, modifier et supprimer les rapports planifiés qui génèrent et envoient les données de dashboards aux destinataires spécifiés.
- Configurer des rapports à envoyer sous format PDF ou Excel, sous forme de liens de téléchargement ou dans des e-mails HTML.
Prérequis
Pour utiliser l’API ScheduledReport, vous avez besoin des éléments suivants :
- Les identifiants de l’API d’Uptrends
- Une compréhension rudimentaire des dashboards et données de dashboards.
Endpoints de l’API ScheduledReport
L’API ScheduledReport fournit les endpoints suivants pour gérer les rapports planifiés :
Gérer les rapports planifiés
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/ScheduledReport |
Récupération d’une liste de toutes les définitions de rapports planifiés et de leur configuration |
POST |
/ScheduledReport |
Création d’un nouveau rapport planifié au moyen d’une configuration donnée |
GET |
/ScheduledReport/{scheduledReportGuid} |
Récupération du rapport planifié spécifié et de sa configuration |
PUT |
/ScheduledReport/{scheduledReportGuid} |
Actualisation de tous les champs de la définition du rapport planifié |
PATCH |
/ScheduledReport/{scheduledReportGuid} |
Actualisation de certains champs de la définition du rapport planifié |
DELETE |
/ScheduledReport/{scheduledReportGuid} |
Suppression du rapport planifié spécifié |
Pour en savoir plus sur les formats des requêtes et des réponses et la réalisation de tests interactifs, vous pouvez consulter la documentation de l’API ScheduledReport d’Uptrends (en anglais).
Réponse de l’API ScheduledReport
{
"ScheduledReportGuid": "a54a4281-5abd-4ac2-a4f6-9f6430b95ee0",
"Hash": "MZsQWQjwYAAyPLY3R3wA9A==",
"FileType": "PDFAttachment",
"IsActive": false,
"Schedule": {
"ScheduleType": "Quarterly",
"Time": "08:00:00",
"MonthDay": 1,
"QuarterStartMonth": 1
},
"SelectedPeriod": "Last24Months",
"InternalNotes": "This is an internal note.",
"Notes": "This is a note. Please find your Uptrends report attached.",
"Recipients": {
"Operators": [],
"OperatorGroups": [
"93d30fd3-6485-411e-9419-7753b5a3d45f"
],
"ExtraEmailAddresses": [
"extraoperator@itrsgroup.com"
]
}
}
Champs de l’API ScheduledReport
L’API ScheduledReport contient plusieurs champs :
| Nom du champ | Description |
|---|---|
ScheduledReportGuid |
L’identifiant unique du rapport planifié |
Hash |
La valeur de hachage correspondant au rapport planifié |
DashboardGuid |
L’identifiant unique du dashboard associé au rapport planifié |
FileType |
Le type de fichier du rapport généré : PDFAttachment (pièce jointe au format PDF), PDFDownloadLink (lien de téléchargement du fichier PDF), ExcelAttachment (pièce jointe au format Excel), ExcelDownloadLink (lien de téléchargement du fichier Excel) ou HTMLEmail (e-mail au format HTML). |
IsActive |
Ce champ indique true si le rapport planifié est actif et envoyé selon l’intervalle spécifié. Autrement, il indique false. |
Schedule |
Ce champ fournit des informations détaillées sur le moment où le rapport est envoyé, dont : |
|
SelectedPeriod |
La période couverte par le rapport planifié. Les options sont les suivantes :
CurrentDay (jour actuel), PreviousDay (jour précédent), Last6Months (6 derniers mois), etc. Pour en savoir plus, vous pouvez vous reporter à notre article sur le champ d’API SelectedPeriod. |
InternalNotes |
Les notes internes du rapport planifié, visibles uniquement pour les administrateurs du compte. |
Notes |
Les notes personnalisées ou descriptions figurant dans le message du rapport. |
Recipients |
Un objet contenant le GUID des opérateurs et des groupes d’opérateurs, ainsi que les autres adresses e-mail qui reçoivent le rapport généré. |
Dépannage
Vous trouverez ci-dessous les erreurs HTTP les plus courantes et les étapes à suivre pour résoudre les problèmes liés à l’API ScheduledReport.
Erreurs courantes
Codes de statut HTTP courants et leurs descriptions :
| Code de statut | Description |
|---|---|
| 200 | OK : requête réussie |
| 201 | Créé : la requête a été bien exécutée et une nouvelle ressource a été créée. Ce code s’applique aux requêtes POST. |
| 204 | Pas de contenu : la requête a été bien exécutée et aucune réponse n’a été envoyée. Ce code s’applique aux requêtes DELETE, PUT et PATCH. |
| 400 | Mauvaise requête : les paramètres de requête sont invalides ou des champs obligatoires sont manquants. |
| 401 | Non autorisé : les identifiants d’authentification sont invalides ou manquants. |
| 403 | Interdit : une ou plusieurs erreurs de validation se sont produites. Ces erreurs peuvent être liées aux autorisations du compte. |
| 404 | Non trouvé : le GUID spécifié n’existe pas. |
| 500 | Erreur de serveur interne : une erreur s’est produite du côté serveur. |
Dépannage général
Pensez à :
- Toujours valider les données de votre requête avant d’envoyer les appels d’API.
- Utiliser des méthodes HTTP appropriées pour chaque opération.
Pour en savoir plus, veuillez contacter notre équipe de support.
Articles liés
Pour en savoir plus, vous pouvez lire les articles suivants :
- Documentation de l’API ScheduledReport d’Uptrends : cette documentation interactive vous fournit des spécifications détaillées sur les endpoints (en anglais).
- Journal de modification des API : cette page rassemble les dernières actualités sur l’API et les avis de retrait.