The Reports page shows details about existing reports associated with the current product view, and lets you edit them and create new reports.
Click on "Add Report" to create a new report.
Click on the report name and press "Edit" to enter the alert report details page.
Column | Description |
---|---|
Description | A description |
for the report. | |
Product | Product Type (choose 'Supported products' when a Report is relevant for all Product Views). |
REST URL |
The URL to use in REST API to perform actions on the report, see Reports REST API from more details. | |
Schedule | When an alert execution will be scheduled. |
Recipients | Email addresses of the recipients for the report publishing. |
Add / Edit Report
Report Details Section
Field | Description |
---|---|
Name | Name of the report. |
Description | Description of the report. |
Product | Product Type |
API Reference | A unique key to be used in REST API. See Reports REST API for more details. |
Schedule | When the report will be executed. See Scheduling a Report for more details. |
Recipients | Email addresses of the recipients for the report publishing. |
Report Query Section
Field | Description |
---|---|
Index Sets | Which |
OpenSearch index sets will be queried (according to product type). See list of index sets for more details. | |
Document Types | Which |
OpenSearch document types will be queried (according to product type) | |
Query (JSON) | An |
OpenSearch query (see Query DSL and Aggregations for more information on how to build a query). | |
Parameters (JSON) | Named parameters to replace placeholders in the query. i.e: |
Headers (JSON) | Named parameters to replace column headers in reports outcome with more meaningful headers. |
Aggs to Ignore | Delimited list of aggregation names to ignore in results. |
Report Filters Section (according to product type and document type)
Field | Description | Product Type |
---|---|---|
Time Range | Time frame for the query to sample the data for the report | Gateway/API-C |
Device | Which DataPower devices the |
report's query should check | Gateway/API-C |
Domain | Which DataPower domains |
the report's query should check | Gateway/API-C | |
Client IP | Which Client IP’s the report's query should check | Gateway/API-C |
Service | Which DataPower services the |
report's query should check | Gateway | |
Service Field Override | Apply the service filter value to a specific Store field. You may leave this field empty unless otherwise advised. | Gateway |
Catalog | Which API-C catalog names |
the report's query should check | API-C |
Space | Which API-C space names |
the report's query should check | API-C |
Product | Which API-C product names |
the report's query should check | API-C |
Plan | Which API-C plan names |
the report's query should check | API-C |
API Name | Which API-C names |
the report's query should check | API-C |
API Version | Which API-C versions |
the report's query should check | API-C |
App Name | Which API-C names |
the report's query should check | API-C |
* By choosing "Adjustable Before Execution", the filter/s will/won't be available in the "Execute Report" page.