The Reports page shows details about existing reports associated with the current product view, and lets you edit them and create new reports.
...
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. |
Service Field Override | Apply the service filter value to a specific Store field. You may leave this field empty unless otherwise advised. |
Report Filters Section (according to product type and document type)
Field | Field Name for REST API | Description | Product Type | Ad Hoc Filter Types for REST API | |||
---|---|---|---|---|---|---|---|
Time Range | see Time Range | Time frame for the query to sample the data for the report | Gateway/API-C | TIME | |||
Device | deviceName | Which DataPower devices the report's query should check | Gateway/API-C | DEVICE | |||
Domain | domainName | Which DataPower domains the report's query should check | Gateway/API-C | DOMAIN | |||
Client IP | clientIp | Which Client IP’s the report's query should check | Gateway/API-C | CLIENT_IP | |||
Service | serviceName | Which DataPower services the report's query should check | Gateway | SERVICE | Service Field Override | Apply the service filter value to a specific Store field. You may leave this field empty unless otherwise advised. | Gateway |
Catalog | Catalog | apicCatalogName | Which API-C catalog names the report's query should check | API-C | APIC_CATALOG | ||
Space | apicSpaceName | Which API-C space names the report's query should check | API-C | APIC_SPACE | |||
Product | apicProductName | Which API-C product names the report's query should check | API-C | APIC_PRODUCT | |||
Plan | apicPlanName | Which API-C plan names the report's query should check | API-C | APIC_PLAN | |||
API Name | apicApiName | Which API-C names the report's query should check | API-C | APIC_API | |||
API Version | apicApiVersion | Which API-C versions the report's query should check | API-C | APIC_API_VERSION | |||
App Name | apicConsumerAppName | Which API-C names the report's query should check | API-C | APIC_CONSUMER_APP |
...