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

ScheduledReport API

Overzicht

In plaats van handmatig dashboardrapporten te genereren en af te leveren, biedt de ScheduledReport API een reeks eindpunten om uw dashboardrapporten automatisch af te leveren met specifieke intervallen, zoals dagelijks, wekelijks, maandelijks, per kwartaal of jaarlijks. U kunt specificeren wie het rapport moet ontvangen, hoe het moet worden afgeleverd en in welk formaat.

Gebruiksscenario’s

Gebruik de ScheduledReport API om:

  • Geplande rapporten te creëren, op te halen, bij te werken en te verwijderen die dashboarddata genereren en naar specifieke ontvangers verzenden.
  • Rapporten te configureren om te worden verzonden als PDF- of Excel-bijlagen, downloadlinks of HTML-e-mails.

Vereisten

Voordat u de ScheduledReport API gebruikt, moet u ervoor zorgen dat u beschikt over:

ScheduledReport API-eindpunten

De ScheduledReport API biedt de volgende eindpunten voor het beheren van geplande rapporten:

Geplande rapporten beheren

Methode Eindpunt Beschrijving
GET /ScheduledReport Haal een lijst op van alle definities van geplande rapporten en hun configuratie.
POST /ScheduledReport Creëer een nieuw gepland rapport met de gegeven configuratie.
GET /ScheduledReport/{scheduledReportGuid} Haal het gespecificeerde geplande rapport en de bijbehorende configuratie op.
PUT /ScheduledReport/{scheduledReportGuid} Werk alle velden van de definitie van het geplande rapport bij.
PATCH /ScheduledReport/{scheduledReportGuid} Werk geselecteerde velden van een definitie van een gepland rapport bij.
DELETE /ScheduledReport/{scheduledReportGuid} Verwijder het gespecificeerde geplande rapport uit uw account.

Voor gedetailleerde request- en response-formaten en interactieve API-tests raadpleegt u de Uptrends ScheduledReport API-documentatie.

ScheduledReport API-response 

{
    "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-velden

The ScheduledReport API bevat verschillende API-velden:

Veldnaam Beschrijving
ScheduledReportGuid De unieke identifier van het geplande rapport.
Hash De hashwaarde die overeenkomt met het geplande rapport.
DashboardGuid De unieke identifier van het dashboard dat is gekoppeld aan het geplande rapport.
FileType Het bestandstype voor het gegenereerde rapport: PDFAttachment, PDFDownloadLink, ExcelAttachment, ExcelDownloadLink of HTMLEmail.
IsActive Geeft true aan als het geplande rapport is ingeschakeld en het rapport volgens een vast schema wordt verzonden. Anders false.
Schedule

Toont gedetailleerde informatie over wanneer het rapport wordt verzonden, inclusief:

  • ScheduleType — hoe vaak het rapport wordt gegenereerd. Opties zijn onder andere: Daily, Weekly, Monthly, Quarterly, Yearly.
  • Time — het tijdstip waarop het rapport wordt gegenereerd, in het formaat HH:MM:SS. Bijvoorbeeld 08:00:00.
  • Day — de specifieke dag op basis van het planningstype. Bijvoorbeeld Weekday voor ScheduleType=Weekly en MonthDay voor ScheduleType=Monthly.
  • QuarterStartMonth — specificeert welke maanden het rapport omvat wanneer het ScheduleType is ingesteld op Quarterly. Opties zijn onder andere: 1 (januari, april, juli, oktober), 2 (februari, mei, augustus, november) of 3 (maart, juni, september, december).
SelectedPeriod
De periode die het geplande rapport bestrijkt. Opties zijn onder andere CurrentDay, PreviousDay, Last6Months en andere. Zie voor meer informatie SelectedPeriod API-veld.
InternalNotes Interne notities voor het geplande rapport, alleen zichtbaar voor accountbeheerders.
Notes Aangepaste notities of beschrijvingen opgenomen in het rapportbericht.
Recipients Een object met de GUID’s van de operators en operatorgroepen, evenals extra e-mailadressen die het gegenereerde rapport ontvangen.

Problemen oplossen

Deze sectie behandelt veelvoorkomende HTTP-fouten en stappen voor probleemoplossing voor de ScheduledReport API.

Veelvoorkomende fouten

Veelvoorkomende HTTP-statuscodes en hun beschrijvingen:

Statuscode Beschrijving
200 OK — request succesvol.
201 Created — de request is succesvol voltooid heeft een nieuwe resource gecreëerd. Dit geldt voor POST-requests.
204 No content — de request is succesvol voltooid en er is geen response geretourneerd. Dit geldt voor DELETE-, PUT en PATCH–requests.
400 Bad request — ongeldige requestparameters of ontbrekende verplichte velden.
401 Unauthorized — ongeldige of ontbrekende authenticatiegegevens.
403 Forbidden — er zijn een of meer validatiefouten opgetreden. Dit kan verband houden met accountrechten.
404 Not Found — de gespecificeerde GUID bestaat niet.
500 Internal Server Error — er is een fout aan de serverzijde opgetreden.

Algemene handleiding voor probleemoplossing

Zorg ervoor dat u:

  • Altijd uw requestdata valideert voordat u API-calls verzendt.
  • Voor elke operation de juiste HTTP-methodes gebruikt.

Neem voor verdere ondersteuning contact op met ons Support-team.

Gerelateerde artikelen

Raadpleeg de volgende artikelen voor meer informatie:

Door deze website te gebruiken, stemt u in met het gebruik van cookies in overeenstemming met ons Cookiebeleid.