PIpicussecurity
Simulation-Result-Reports

# Generate Simulation Report

Generates a report for the specified simulation. The report can either provide an overview or focus on a specific run of the simulation, depending on the parameters.

post/v2/simulations/{Id}/results/reports

Request

Path parameters

Idinteger required

Simulation ID

Query parameters

typestring required

Type of the report. One of: 'run' | 'overview'

runIdstring

Id of the run or 'latest'. Required if type is 'run'

Request body

formatstring[]

Corresponding report will be generated for each format specified. Available formats: PDF, CSV

includesSensitiveDataboolean

If false, generated report will display threat information with access links (Only for CSV reports)

onlyPreventionboolean

If true, generated report will include only prevention results

Example request

{
  "format": [
    "PDF"
  ]
}

Response

GenerateSimulationReportResponse

formatstring

Report Format. One of: 'PDF' | 'CSV'

idinteger

Report Id

statusstring

Report Status. One of: 'IN PROGRESS' | 'COMPLETED' | 'ERROR'

Example response

[
  {
    "format": "PDF",
    "id": 1,
    "status": "COMPLETED"
  }
]

Changes

No recorded changes to this operation across all 6 revisions of this API.