Page Comparison

Description

A description of for the report.

Product

Product Type (choose 'Supported products' when a Report is relevant for all Product Views).

REST URL

Report invocation can be integrated with external application via rest apiThe 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.

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.