GET [/instances/$INSTANCES]/private/reports

This is used to return all the scheduled reports that are present in our backend.

Required permission: reports-read

Request:

Query Parameters:

• limit – Optional. At most return the given number of results. Negative for descending by serial, positive for ascending by serial. Defaults to -20.

• offset – Optional. Starting serial for pagination.

Response:

200 OK:

The backend has successfully returned all the reports. Returns a ReportsSummaryResponse.

404 Not found:

The backend has does not know about the instance.

Details:

interface ReportsSummaryResponse {

  // Return reports that are present in our backend.
  reports: ReportEntry[];

}

The ReportEntry object describes a report. It has the following structure:

interface ReportEntry {

  // Report identifier
  report_serial: Integer;

  // Description for the report.
  description: string;

  // Frequency for the report.
  report_frequency: RelativeTime;

}