1. Support
  2. Knowledge Base
  3. Uptrends' API
  4. ScheduledReport API

ScheduledReport API

Überblick

Statt manuell Dashboard-Berichte zu erzeugen und zu senden, bietet die ScheduledReport API eine Reihe von Endpunkten, um automatisch Dashboard-Berichte in bestimmten Intervallen wie täglich, wöchentlich, monatlich, vierteljährlich oder jährliche zu senden. Du kannst festlegen, wer die Berichte erhält, wie und in welchem Format sie gesendet werden.

Einsatzbereiche

Nutze die ScheduledReport API, um:

  • geplante Berichte, die Dashboard-Daten generieren und an bestimmte Empfänger senden, zu erzeugen, abzurufen, zu aktualisieren und zu löschen.
  • Berichte zu konfigurieren, die als PDF- oder Excel-Anhang, Download-Links oder HTML-E-Mails gesendet werden.

Voraussetzungen

Bevor du die ScheduledReport API nutzt, achte darauf, dass du über Folgendes verfügst:

ScheduledReport API-Endpunkte

Die ScheduledReport API bietet die folgenden Endpunkte zum Verwalten von geplanten Berichten:

Geplante Berichte verwalten

Methode Endpunkt Beschreibung
GET /ScheduledReport Rufe eine Liste aller Definitionen geplanter Berichte und ihre Konfiguration ab.
POST /ScheduledReport Erstelle neue geplante Berichte anhand einer gegebenen Konfiguration.
GET /ScheduledReport/{scheduledReportGuid} Rufe den angegebenen geplanten Bericht und seine Konfiguration ab.
PUT /ScheduledReport/{scheduledReportGuid} Aktualisiere alle Felder der Definition des geplanten Berichts.
PATCH /ScheduledReport/{scheduledReportGuid} Aktualisiere die ausgewählten Felder der Definition eines geplanten Berichts.
DELETE /ScheduledReport/{scheduledReportGuid} Entferne den angegebenen geplanten Bericht aus deinem Account.

Mehr Informationen zu den Abfrage- und Antwortformaten und zu interaktiven API-Tests findest du in der Uptrends ScheduledReport API-Dokumentation.

ScheduledReport API-Antwort 

{
    "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"
      ]
    }
  }

ScheduledReport API-Felder

Die ScheduledReport API enthält verschiedene API-Felder:

Feldname Beschreibung
ScheduledReportGuid Die einzigartige Kennung des geplanten Berichts.
Hash Der Hash-Wert zum geplanten Bericht.
DashboardGuid Die einzigartige Kennung des Dashboards zum geplanten Bericht.
FileType Der Dateityp des erzeugten Berichts: PDFAttachment, PDFDownloadLink, ExcelAttachment, ExcelDownloadLink oder HTMLEmail.
IsActive Lautet true, wenn der geplante Bericht aktiviert wurde und den Bericht regelmäßig sendet. Andernfalls lautet es false.
Schedule

Gibt detaillierte Informationen, wann der Bericht gesendet wird, einschließlich:

  • ScheduleType – wie häufig der Bericht generiert wird. Optionen umfassen: Daily, Weekly, Monthly, Quarterly, Yearly.
  • Time – der Zeitpunkt, wann der Bericht erzeugt wird, im Format HH:MM:SS. Zum Beispiel 08:00:00.
  • Day – der Tag, basierend auf dem Plantyp. Zum Beispiel: Weekday für ScheduleType=Weekly und MonthDay für ScheduleType=Monthly.
  • QuarterStartMonth – gibt an, welchen Monat der Bericht abdeckt, wenn der ScheduleType auf Quarterly eingestellt ist. Optionen umfassen: 1 (Januar, April, Juli, Oktober), 2 (Februar, Mai, August, November) oder 3 (März, Juni, September, Dezember).
SelectedPeriod
Der abgedeckte Zeitraum des geplanten Berichts. Optionen sind CurrentDay, PreviousDay, Last6Months und weitere. Weitere Informationen findest du unter SelectedPeriod API-Feld.
InternalNotes Interne Anmerkungen für den geplanten Bericht, die nur für Account-Administratoren sichtbar sind.
Notes Benutzerdefinierte Anmerkungen oder Beschreibung, die in der Berichtsmeldung enthalten sind.
Recipients Ein Objekt mit den GUIDs der Operatoren und Operator-Gruppen sowie zusätzliche E-Mail-Adressen, die den erzeugten Bericht erhalten.

Fehlerbehebung

Dieser Abschnitt behandelt übliche HTTP-Fehler und Schritte zur Fehlerbehebung bei der ScheduledReport API.

Übliche Fehler

Übliche HTTP-Statuscodes und ihre Beschreibungen:

Statuscode Beschreibung
200 OK – Abfrage erfolgreich.
201 Erzeugt – die Anfrage wurde vollständig erfolgreich ausgeführt und hat eine neue Ressource erzeugt. Dies ist der Fall bei POST-Abfragen.
204 Kein Inhalt – die Abfrage wurde erfolgreich gesendet und es wurde keine Antwort zurückgegeben. Dies ist der Fall bei DELETE-, PUT- und PATCH-Abfragen.
400 Ungültige Abfrage – ungültige Abfrageparameter oder fehlende erforderliche Felder.
401 Nicht autorisiert – ungültige oder fehlende Authentifizierungsdaten.
403 Verboten – es gab einen oder mehrere Validierungsfehler. Das kann in Verbindung mit Accountberechtigungen auftreten.
404 Nicht gefunden – die angegebene GUID existiert nicht.
500 Interner Serverfehler – ein serverseitiger Fehler ist aufgetreten.

Leitfaden zur allgemeinen Fehlerbehebung

Stelle sicher, dass:

  • du immer deine Abfragedaten validierst, bevor du einen API-Aufruf sendest.
  • du die entsprechenden HTTP-Methoden für jede Operation verwendest.

Solltest du weitere Hilfe benötigen, wende dich bitte an unser Support-Team.

Verwandte Artikel

Weitere Informationen findest du in den folgenden Artikeln:

Durch die Nutzung dieser Website stimmen Sie der Verwendung von Cookies gemäß unserer Cookie-Richtlinien zu.