Page Comparison

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).
A search query, or query, is a request for information about data in OpenSearch indices.
The query results can contain hits /aggregation or both. The report will contain all the search results.
By default, searches containing hits, return all source field names. To return only specific field names, one should include them in the query. See DPOD Store for more detailed information about the field names.
By default, searches containing an aggregation return both search hits and aggregation results. To return only aggregation results (usually that’s what we would want the report to contain), set size to 0.
A meaningful name should be given to the aggregation names since they are used as the column headers in the report.

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.

Time RangetimeRangeType

see Time Range recentPeriodInMillis

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

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