Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Reports page shows details about existing system reports associated to the current product view, and lets you edit them and create new reports.

...

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).
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.
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.

...