Skip to main content

Retrieve Findings Scheduled Report

GET 
/stored-reports/:id/

Request​

Path Parameters

    id stringrequired

Responses​

Schema

    id stringrequired

    A unique Base58 value identifying this object.

    name stringrequired

    Possible values: <= 255 characters

    Name of the report.

    date_time date-timenullable

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

    recurrence string

    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 string

    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 boolean

    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 integernullable

    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 stringnullable

    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

    object

    required

    severity integer[]

    Filter findings by severity

    state string[]

    Filter findings by state

    assignee string[]

    Filter findings by assignee's user ID

    label string[]

    Filter findings by label ID

    new booleannullable

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

    target_label string[]

    Filter findings by target label ID

    target string[]

    Filter findings by target ID

    team string[]

    Filter findings by team ID

    search string

    Possible values: <= 1024 characters

    Search findings

    assessment string

    Filter findings by assessment ID

    findings string[]

    Filter findings by IDs

    report_type string

    Possible values: [default, executive_summary, owasp, pci, pci4, iso27001, hipaa]

    • default - Standard
    • executive_summary - Executive Summary
    • owasp - OWASP Top 10
    • pci - PCI v3.2.1
    • pci4 - PCI v4.0.1
    • iso27001 - ISO 27001
    • hipaa - HIPAA
    report_fileformat string

    Possible values: [pdf, docx]

    Format for the report to produce.

    • pdf - PDF file format.
    • docx - DOCX file format.
    report_type string

    Default value: default

    report_fileformat string

    Default value: pdf

    enabled booleanrequired

    If true, the report is generated.
    Defaults to true.

Loading...