Download Findings Scheduled Report Preview

POST 
/stored-reports/preview/

Request

application/json

Body

required

name stringrequired

Possible values: <= 255 characters

Name of the report.

date_time date-timenullablerequired

Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

recurrence stringrequired
Possible values: [h, d, w, m, q, ``]
Recurrence of the report generation:
(if "" it's a one-time report)
• h - Hourly
• d - Daily
• w - Weekly
• m - Monthly
• q - Quarterly
timezone stringrequired

Possible values: <= 64 characters

Two-letter country code for the time zone of the date_time, as an ISO 3166-1 alpha-2 code.

on_day_of_week booleanrequired

If true, the report is scheduled to be generated on a specific week.
If false, the report is generated on the day set in date_time.
This is only applicable if the recurrence is monthly or quarterly.
Defaults to false.

scheduled_day_of_week integernullablerequired
Possible values: >= -2147483648 and <= 2147483647, [1, 2, 3, 4, 5, 6, 7, null]
The day of the week on which the report is generated:
(This is only applicable if on_day_of_week is true)
• 1 - Monday
• 2 - Tuesday
• 3 - Wednesday
• 4 - Thursday
• 5 - Friday
• 6 - Saturday
• 7 - Sunday
week_index stringnullablerequired
Possible values: [first, second, third, fourth, last, ``, null]
The week of the month in which the report is generated:
(This is only applicable if on_day_of_week is true)
• first - First
• second - Second
• third - Third
• fourth - Fourth
• last - Last
filters objectrequired

severity object

property name* anyrequired

state object

property name* anyrequired

assignee object

property name* anyrequired

label object

property name* anyrequired

new booleannullablerequired

If true, filter results by new findings.
If false, filter results by old findings.

target_label object

property name* anyrequired

target object

property name* anyrequired

team object

property name* anyrequired

search stringrequired

Possible values: <= 1024 characters

Search findings

report_type stringrequired

Default value: default

report_fileformat stringrequired

Default value: pdf

application/x-www-form-urlencoded

Body

required

name stringrequired

Possible values: <= 255 characters

Name of the report.

date_time date-timenullablerequired

Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

recurrence stringrequired
Possible values: [h, d, w, m, q, ``]
Recurrence of the report generation:
(if "" it's a one-time report)
• h - Hourly
• d - Daily
• w - Weekly
• m - Monthly
• q - Quarterly
timezone stringrequired

Possible values: <= 64 characters

Two-letter country code for the time zone of the date_time, as an ISO 3166-1 alpha-2 code.

on_day_of_week booleanrequired

If true, the report is scheduled to be generated on a specific week.
If false, the report is generated on the day set in date_time.
This is only applicable if the recurrence is monthly or quarterly.
Defaults to false.

scheduled_day_of_week integernullablerequired
Possible values: >= -2147483648 and <= 2147483647, [1, 2, 3, 4, 5, 6, 7, null]
The day of the week on which the report is generated:
(This is only applicable if on_day_of_week is true)
• 1 - Monday
• 2 - Tuesday
• 3 - Wednesday
• 4 - Thursday
• 5 - Friday
• 6 - Saturday
• 7 - Sunday
week_index stringnullablerequired
Possible values: [first, second, third, fourth, last, ``, null]
The week of the month in which the report is generated:
(This is only applicable if on_day_of_week is true)
• first - First
• second - Second
• third - Third
• fourth - Fourth
• last - Last
filters objectrequired

severity object

property name* anyrequired

state object

property name* anyrequired

assignee object

property name* anyrequired

label object

property name* anyrequired

new booleannullablerequired

If true, filter results by new findings.
If false, filter results by old findings.

target_label object

property name* anyrequired

target object

property name* anyrequired

team object

property name* anyrequired

search stringrequired

Possible values: <= 1024 characters

Search findings

report_type stringrequired

Default value: default

report_fileformat stringrequired

Default value: pdf

multipart/form-data

Body

required

name stringrequired

Possible values: <= 255 characters

Name of the report.

date_time date-timenullablerequired

Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

recurrence stringrequired
Possible values: [h, d, w, m, q, ``]
Recurrence of the report generation:
(if "" it's a one-time report)
• h - Hourly
• d - Daily
• w - Weekly
• m - Monthly
• q - Quarterly
timezone stringrequired

Possible values: <= 64 characters

Two-letter country code for the time zone of the date_time, as an ISO 3166-1 alpha-2 code.

on_day_of_week booleanrequired

If true, the report is scheduled to be generated on a specific week.
If false, the report is generated on the day set in date_time.
This is only applicable if the recurrence is monthly or quarterly.
Defaults to false.

scheduled_day_of_week integernullablerequired
Possible values: >= -2147483648 and <= 2147483647, [1, 2, 3, 4, 5, 6, 7, null]
The day of the week on which the report is generated:
(This is only applicable if on_day_of_week is true)
• 1 - Monday
• 2 - Tuesday
• 3 - Wednesday
• 4 - Thursday
• 5 - Friday
• 6 - Saturday
• 7 - Sunday
week_index stringnullablerequired
Possible values: [first, second, third, fourth, last, ``, null]
The week of the month in which the report is generated:
(This is only applicable if on_day_of_week is true)
• first - First
• second - Second
• third - Third
• fourth - Fourth
• last - Last
filters objectrequired

severity object

property name* anyrequired

state object

property name* anyrequired

assignee object

property name* anyrequired

label object

property name* anyrequired

new booleannullablerequired

If true, filter results by new findings.
If false, filter results by old findings.

target_label object

property name* anyrequired

target object

property name* anyrequired

team object

property name* anyrequired

search stringrequired

Possible values: <= 1024 characters

Search findings

report_type stringrequired

Default value: default

report_fileformat stringrequired

Default value: pdf

Responses

200

application/json

Schema

Schema

results object[]required

Example (from schema)

{
  "results": [
    {}
  ]
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...