Reporting APIs
Reporting APIs allow users to generate application reports. Instead of first exporting generated data, such as traffic flows, and then using other tools to create reports, users can now use built-in reports.
Users can request one-time or recurring reports and specify time ranges and report types.
Reporting APIs belong to several groups based on their use:
Reporting API Types
Reporting Schedules
These APIs allow the Global Organization Administrator (this_global_org_user)
to manage report schedules.
Each report can be generated once or recurring, where the recurrence is specified during report configuration.
The default time range is 30 days, and other possible values are 1 day, 7 days, 14 days, 30 days, 60 days, and 90 days.
Functionality | HTTP | URI |
---|---|---|
Returns a collection of report schedules. |
|
|
Returns a scheduled report for the provided UUID. |
|
|
Updates a report schedule for the provided UUID. |
|
|
Create a new report schedule. |
|
|
Deletes a report schedule for the provided UUID. |
|
|
Defining Report Schedule Query
To define the query for report schedules, reference the required schemas (explained in Schemas to Define a Report).
executive_summary_report_params.schema.json
traffic_flow_report_params.schema.json
report_app_groups.schema.json
custom_date_range.schema.json
ves_report_params.schema.json
Report Templates
These APIs allow the Global Organization Administrator (this_global_org_user
) to manage report templates. In each report template, they can specify the type, time range, recurrence, and suitable parameters for the report type.
Functionality | HTTP | URI |
---|---|---|
Lists the collection of all available report templates for this user and organization. |
|
|
This API is used to enable/disable a specific report type, which can be done only by the organization administrator. |
|
|
Defining Report Templates Query
To define the query for report templates, reference the required schemas (explained in Schemas to Define a Report).
On-Demand Reports
The user authorized as the Global Organization Administrator (this_global_org_user
) can download various kinds of reports, create them on-demand, or add the property report_format
to determine the format in which the report will be generated.
Functionality | HTTP | URI |
---|---|---|
Returns a collection of reports. |
|
|
Returns a report for the provided UUID. |
|
|
Downloads a specific report. |
|
|
Creates a new on-demand report. |
|
|
Cancels a report if it's not yet completed/failed |
|
|
Added a new property |
|
|
Added a new property |
|
|
Report Settings
Report Settings define how many days a report will be stored or persisted.
The user authorized as the Global Organization Administrator (this_global_org_user) can manage the report settings, list them, or update them.
Functionality | HTTP | URI |
---|---|---|
Get the report settings for an organization. |
|
|
Updates the report settings for an organization. |
|
|
Schemas to Define a Report
These schemas are referenced and used to define the content of a report:
executive_summary_report_params.schema.json
Reports parameters for the executive summary report, such as
report_time_range
(Time range the report is built across) and references toreport_time_range_definitions.schema.json#/definitions/custom_date_range
or
report_time_range_definitions.schema.json#/definitions/last_num_days
.
traffic_flow_report_params.schema.json
Reports parameters for traffic flow query report.
report_app_groups.schema.json
This is the App Group Schema for reports.
custom_date_range.schema.json
Provides the time range the report is built across.
common legacy_workload_modes.schema.json
Provides the assigned labels summary with the label URI, as well as the key and value in the key-value pair.
report_time_range_definitions.schema.json
Provides the report parameters for the executive summary report, such as Start date for the range, End date for the range, and Last x number of days the report is built across.
labels_summary.schema.json
Provides the assigned labels summary with properties such as label URI, Key in key-value pair, and Value in key-value pair.
ves_report_params.schema.json
Provides report parameters for the new VES (vulnerability-exposure score ) report type.