reports
Report Service
Returns the list of report types available on this hub. Use the returned type identifiers when creating new scheduled reports with the AddScheduledReport endpoint.
Report Service
Returns the list of report types available on this hub using a POST body. Use the returned type identifiers when creating new scheduled reports with the AddScheduledReport endpoint.
Report Service
Returns the raw content of a report layout template. Use this endpoint to retrieve a template for inspection or as the basis for a customized version.
Report Service
Returns the raw content of a report layout template using a POST body. Use this endpoint to retrieve a template for inspection or as the basis for a customized version.
Report Service
Returns a list of all available report layout templates. Use the returned template names and versions when selecting a layout for report rendering or when managing custom templates.
Report Service
Returns a list of all available report layout templates using a POST body. Use the returned template names and versions when selecting a layout for report rendering or when managing custom templates.
Report Service
Returns the list of currently configured scheduled reports. The response lists each report's current state including its schedule, visibility settings, and last execution details.
Report Service
Returns the list of currently configured scheduled reports using a POST body. The response lists each report's current state including its schedule, visibility settings, and last execution details.
Report Service
Updates an existing report layout template on the hub. Use this endpoint to push a revised template definition and replace the current version.
Report Service
Updates an existing report layout template on the hub using a POST body. Use this endpoint to push a revised template definition and replace the current version.
Report Service
Uploads a new custom report layout template to the hub. Returns 204 No Content on success. Use this endpoint to deploy bespoke report templates that are then available for selection when rendering reports.
Delete report layout template
Permanently removes a custom report layout template identified by its type, name, and version. This operation cannot be undone, so ensure the correct template is targeted before calling this endpoint.
Delete report layout template
Permanently removes a custom report layout template identified by its type, name, and version using a POST body. This operation cannot be undone, so ensure the correct template is targeted before calling this endpoint.
Get device monitoring report data
Returns the data required to populate a device monitoring report. Filter results by device group, online status, or a date range. Use the Groups parameter to limit results to specific device groups and their children.
Get device monitoring report data
Returns the data required to populate a device monitoring report using a POST body. Filter results by device group, online status, or a date range. Use the Groups parameter to limit results to specific device groups and their children.
GetRuleResultsruleresults_Get
GetRuleResultsruleresults_Get
GetRuleResultsruleresults_Post
GetRuleResultsruleresults_Post
Get generated report output file
Downloads a previously generated report output file. Use this endpoint after a report has been rendered and the output saved to retrieve the file content for display or export.
Get generated report output file
Downloads a previously generated report output file using a POST body. Use this endpoint after a report has been rendered and saved to retrieve the file content for display or export.
Deletes previously generated report output files
Permanently removes previously generated report output files from the hub. Use this endpoint to free storage space or to clear stale rendered outputs before regenerating a report.
Deletes previously generated report output files
Permanently removes previously generated report output files from the hub using a POST body. Use this endpoint to free storage space or to clear stale rendered outputs before regenerating a report.
Report Service
Permanently deletes a specific scheduled report instance identified by its ReportItemId and InstanceId. This removes the instance record and any associated output from the hub.
Report Service
Permanently deletes a specific scheduled report instance identified by its ReportItemId and InstanceId using a POST body. This removes the instance record and any associated output from the hub.
Report Service
Updates the retention lifetime of a specific scheduled report instance. Use this endpoint to extend or shorten how long a generated instance is kept before the hub automatically removes it.
Report Service
Updates the retention lifetime of a specific scheduled report instance using a POST body. Use this endpoint to extend or shorten how long a generated instance is kept before the hub automatically removes it.
Report Service
Returns information about rendered instances of scheduled reports, including their availability and output locations. Optionally filter by ReportItemId to limit results to a specific report.
Report Service
Returns information about rendered instances of scheduled reports using a POST body, including their availability and output locations. Optionally filter by ReportItemId to limit results to a specific report.
Add scheduled report
Creates a new scheduled report of the type identified by the Id parameter. You can optionally create the report as a copy of an existing one using the AsCopyOf parameter. The response lists the updated state of all affected reports.
Add scheduled report
Creates a new scheduled report of the type identified by the Id parameter using a POST body. You can optionally create the report as a copy of an existing one using the AsCopyOf parameter. The response lists the updated state of all affected reports.
Report Service
Updates the settings of an existing scheduled report, including its schedule, sub-reports, email delivery options, and visibility flags. The response lists the updated state of all affected reports.
Report Service
Updates the settings of an existing scheduled report using a POST body, including its schedule, sub-reports, email delivery options, and visibility flags. The response lists the updated state of all affected reports.
Report Service
Permanently removes one or more scheduled reports from the hub. Returns a boolean indicating whether the deletion was successful.
Report Service
Permanently removes one or more scheduled reports from the hub using a POST body. Returns a boolean indicating whether the deletion was successful.
Report Service
Returns information about one or more scheduled report instances. Provide both a ReportItemId and an InstanceId to retrieve a specific instance. Use SummaryOnly to limit the response to summary fields for display in a reporting UI.
Report Service
Returns information about one or more scheduled report instances using a POST body. Provide both a ReportItemId and an InstanceId to retrieve a specific instance. Use SummaryOnly to limit the response to summary fields.