ITRS named a Visionary in the 2025 Gartner® Magic Quadrant™ for Digital Experience Monitoring.

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

ScheduledReport API

Overview

Instead of manually generating and sending dashboard reports, the ScheduledReport API provides a set of endpoints to automatically deliver your dashboard reports at specified intervals, such as daily, weekly, monthly, quarterly, or yearly. It lets you specify who should receive the report, how it should be delivered, and in which format.

Use cases

Use the ScheduledReport API to:

  • Create, retrieve, update, and delete scheduled reports that generate and send dashboard data to specified recipients.
  • Configure reports to be delivered as PDF or Excel attachments, download links, or HTML emails.

Prerequisites

Before using the ScheduledReport API, make sure you have:

ScheduledReport API endpoints

The ScheduledReport API provides the following endpoints for managing scheduled reports:

Manage scheduled reports

Method Endpoint Description
GET /ScheduledReport Retrieve a list of all scheduled report definitions and their configuration.
POST /ScheduledReport Create a new scheduled report using the given configuration.
GET /ScheduledReport/{scheduledReportGuid} Retrieve the specified scheduled report and its configuration.
PUT /ScheduledReport/{scheduledReportGuid} Update all fields of the scheduled report definition.
PATCH /ScheduledReport/{scheduledReportGuid} Update selected fields of a scheduled report definition.
DELETE /ScheduledReport/{scheduledReportGuid} Remove the specified scheduled report from your account.

For detailed request and response formats, and interactive API testing, refer to the Uptrends ScheduledReport API documentation.

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 fields

The ScheduledReport API contains various API fields:

Field name Description
ScheduledReportGuid The unique identifier of the scheduled report.
Hash The hash value corresponding to the scheduled report.
DashboardGuid The unique identifier of the dashboard associated with the scheduled report.
FileType The file type for the generated report: PDFAttachment, PDFDownloadLink, ExcelAttachment, ExcelDownloadLink, or HTMLEmail.
IsActive Indicates true if the scheduled report is enabled and sends the report on a regular schedule. Otherwise, false.
Schedule

Shows detailed information on when the report is sent, including:

  • ScheduleType — how often the report is generated. Options include: Daily, Weekly, Monthly, Quarterly, Yearly.
  • Time — the time when the report is generated, in HH:MM:SS format. For example 08:00:00.
  • Day — the specific day based on the schedule type. For example, Weekday for ScheduleType=Weekly and MonthDay for ScheduleType=Monthly.
  • QuarterStartMonth — specifies which months the report covers when the ScheduleType is set to Quarterly. Options include: 1 (January, April, July, October), 2 (February, May, August, November), or 3 (March, June, September, December).
SelectedPeriod
The scheduled report’s period coverage. Options include CurrentDay, PreviousDay, Last6Months, and others. For more information, see SelectedPeriod API field.
InternalNotes Internal notes for the scheduled report, visible only to account administrators.
Notes Custom notes or description included in the report message.
Recipients An object containing the GUIDs of the operators and operator groups, as well as extra email addresses that receive the generated report.

Troubleshooting

This section covers common HTTP errors and troubleshooting steps for the ScheduledReport API.

Common errors

Common HTTP status codes and their descriptions:

Status Code Description
200 OK — request successful.
201 Created — the request completed successfully and created a new resource. This is for POST requests.
204 No content — the request completed successfully and no response was returned. This is for DELETE, PUT, and PATCH requests.
400 Bad request — invalid request parameters or missing required fields.
401 Unauthorized — invalid or missing authentication credentials.
403 Forbidden — one or more validation errors occurred. This may be related to account permissions.
404 Not Found — the specified GUID does not exist.
500 Internal Server Error — a server-side error occurred.

General troubleshooting guide

Ensure that you:

  • Always validate your request data before sending API calls.
  • Use appropriate HTTP methods for each operation.

For further assistance, please reach out to our Support team.

For more details, refer to the following articles:

By using the Uptrends website, you consent to the use of cookies in accordance with our Cookie Policy.