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

This is used to obtain detailed information about a specific scheduled report.

Required permission: reports-read

Response:

200 OK:

The backend has successfully returned the detailed information about a specific report. Returns a ReportDetailResponse.

404 Not found:

The report or instance is unknown to the backend.

Details:

interface ReportDetailResponse {

  // Report identifier
  report_serial: Integer;

  // Description of the report. Possibly included
  // in the report message.
  description: string;

  // Merchant backend configuration section specifying
  // the program to use to transmit the report
  program_section: string;

  // Mime-type to request from the data source.
  mime_type: string;

  // Base URL to request the data from.
  data_source: string;

  // Address where the report program should send
  // the report.
  target_address: string;

  // Report frequency
  report_frequency: RelativeTime;

  // Report frequency shift
  report_frequency_shift: RelativeTime;

  // Numeric error code unique to the
  // error encountered in generating the latest report.
  // Absent if there was no error.
  last_error_code?: Integer;

  // Details about any error encountered
  // in generating the latest report.
  last_error_detail?: string;
}