Queue a report export

The type of report to export. Note that each report type may require different parameters to be specified in the request.

When VendorRiskAssessmentPDF is selected the latest published risk assessment will be used, if no published risk assessment is available for the selected vendor a 422 error will be returned.

For an export of type 'CustomPDF', specify the UUID of the custom report to generate. This is a required field for the custom report type.

Optionally email the generated report to the specified addresses when it is ready.

Optionally specify a URL that will receive a POST request when the report is ready. The request will contain a JSON body containing a URL to download the report, in the following format:

{
"queued_report_id": "string",
"download_url": "url"
"download_url_expires": "string"
}

Filter by asset portfolio names. Case-sensitive. Optional. Applicable only when report_type is BreachSightSummaryPDF or BreachSightDetailedPDF.

Filter by vendor portfolio names. Case-sensitive. Optional. Applicable only when report_type is BoardSummaryPDF, BoardSummaryPPTX, or VendorRiskExecutiveSummaryPDF.

ID of the vendor to generate the report for. Either this, vendor_primary_hostname or filter_by_vendor_hostnames are required when report_type is VendorSummaryPDF, VendorDetailedPDF, VendorRiskAssessmentPDF, CustomPDF, VendorRiskProfileXLSX, VendorVulnsOverviewXLSX, VendorDomainListPDF, QuestionnaireDetailsPDF or QuestionnaireDetailsXLSX.

Primary hostname of the vendor to generate the report for. Either this, vendor_id or filter_by_vendor_hostnames are required when report_type is VendorSummaryPDF, VendorDetailedPDF, VendorRiskAssessmentPDF, CustomPDF, VendorRiskProfileXLSX, VendorVulnsOverviewXLSX, VendorDomainListPDF, QuestionnaireDetailsPDF or QuestionnaireDetailsXLSX.

List of hostnames from a single vendor to generate the report for. Either this, vendor_id or vendor_primary_hostname are required when report_type is VendorSummaryPDF, VendorDetailedPDF, CustomPDF, VendorRiskProfileXLSX, VendorVulnsOverviewXLSX or VendorDomainListPDF.

String to use as the first part of the report filename. For vendor reports this will precede the vendor name, and for others the account name. A maximum of the first 20 characters (runes) of the supplied string will be used

When requesting a vendor report, determine if the report should wait for the appropriate data to become available. This is typical of reports where the vendor may have only just become known by the system, or the vendor only just been watched by the account. Typically, the report generation and delivery is delayed by up to 72 hours to allow for the data to become available. This parameter is only valid when report_type is VendorSummaryPDF*, VendorDetailedPDF, CustomPDF, VendorRiskProfileXLSX, VendorVulnsOverviewXLSX, or VendorDomainListPDF.

The ID of the questionnaire to generate the report for. Required when report_type is QuestionnaireDetailsPDF or QuestionnaireDetailsXLSX.

Whether to include correspondence messages in the questionnaire details report. Optional. Applicable only when report_type is QuestionnaireDetailsPDF or QuestionnaireDetailsXLSX.

Whether to include private/internal messages in the questionnaire details report. Only available to the questionnaire author organization. Optional. Applicable only when report_type is QuestionnaireDetailsPDF or QuestionnaireDetailsXLSX.