@dynatrace-sdk/client-query 1.2.0 → 1.3.0

package/docs/DOCS.md

@@ -1,20 +1,36 @@
+---
+title: Storage – Query Service
+description: Exposes an API to fetch records stored in Grail.
+---
+
 # Storage – Query Service
 
-SDK package version **1.2.0**
+Exposes an API to fetch records stored in Grail
+
+import NpmLogo from '@site/static/img/npm-logo.png';
+
+<div class="row margin-bottom--md">
+  <div class="col">
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query">
+      <span class="margin-right--xs">@dynatrace-sdk/client-query</span>
+      <img className="no-zoom" width="20px" src={NpmLogo} />
+    </a>
+  </div>
+  <div class="col" style={{textAlign: 'right'}}>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.3.0">v1.3.0</a>
+  </div>
+</div>
 
 ```bash
 npm install @dynatrace-sdk/client-query
 ```
 
-Exposes an API to fetch records stored in Grail
-
 ## queryAssistanceClient
 
 ```js
-import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
+import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
 ```
 
-
 ### queryAutocomplete
 
 <div class="padding-bottom--md">
@@ -31,21 +47,21 @@ For information about the required permissions see the [Bucket and table permiss
 We provide a list of suggestions that may be used after the cursor position. The following queries will all provide the
 same results:
 
-* `query: "f"`
-* `query: "f", cursorPosition:1`
-* `query: "fetch ", cursorPosition:1`
+- `query: "f"`
+- `query: "f", cursorPosition:1`
+- `query: "fetch ", cursorPosition:1`
 
 Available fields:
 
 | Field       | Description                                                                                                                                                                             |
-|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | suggestions | a list of suggestions. Each item is a separate possible suggestion, despite they might have the same outputs.                                                                           |
 | optional    | whether the suggestion is optional. If `true`, the query until the cursor position might work. If `false`, the query is definitely incomplete or invalid if cut at the cursor position. |
 
 Fields in the `suggestions`
 
 | Field                  | Description                                                                                                |
-|------------------------|------------------------------------------------------------------------------------------------------------|
+| ---------------------- | ---------------------------------------------------------------------------------------------------------- |
 | suggestion             | a string representing the whole suggestion. This information could also be derived from the parts.         |
 | alreadyTypedCharacters | how many characters of this suggestion have already been typed (and will be overridden by the suggestion). |
 | parts                  | a list of semantically enriched information on what are the parts of a suggestion.                         |
@@ -53,40 +69,29 @@ Fields in the `suggestions`
 Fields in `parts`
 
 | Field      | Description                                               |
-|------------|-----------------------------------------------------------|
+| ---------- | --------------------------------------------------------- |
 | suggestion | a string representing the current part of the suggestion. |
 | type       | current types: SPACE, PIPE, COMMAND (may be extended)     |
 
 The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
 a link to docs, etc.
 
-
 **Parameters**
 
 <div class="padding-left--md padding-bottom--md">
 <strong>config</strong>: Object
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -95,24 +100,15 @@ The authorization context. Typically start with 'Bearer '.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.body</strong>: <a href="#autocompleterequest">AutocompleteRequest</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
-
 #### Returns
 
 <div class="padding-left--md">
@@ -120,16 +116,26 @@ A list of structured autocomplete suggestions.
 
 </div>
 
+<details>
+<summary>
+Code example
 
+</summary>
 
+```ts
+import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
 
+const data = await queryAssistanceClient.queryAutocomplete({
+  authorization: "...",
+  body: {} as AutocompleteRequest,
+});
+```
 
-</div>
-
-
+</details>
 
 </div>
 
+</div>
 
 ### queryParse
 
@@ -154,20 +160,20 @@ The query tree consists of nodes that contain different additional information (
 
 ### General Fields
 
-Field | Mandatory |  Description
------------------------ | --- | ----------------------------------------------------------------------------------------
-tokenPosition           | no  | optional. If present, it represents the position within the query string where the node refers to.
-isOptional              | no  | whether this node could be left out and the result would still be the same query (semantically).
+| Field         | Mandatory | Description                                                                                        |
+| ------------- | --------- | -------------------------------------------------------------------------------------------------- |
+| tokenPosition | no        | optional. If present, it represents the position within the query string where the node refers to. |
+| isOptional    | no        | whether this node could be left out and the result would still be the same query (semantically).   |
 
 #### tokenPosition
 
 contains `start` (inclusive) and `end` (inclusive), both contain `index` (0 based; fur substrings), `line`
 and `column` (both 1-based; for readability).
 
-* If `tokenPosition` is present, it always contains start and end with all fields
-* If `tokenPosition` is not present, there might still be nested nodes that do contain a position
-* If `start == end`, the position refers to a single character
-* If `start &gt; end`, we know for sure that something was inserted.
+- If `tokenPosition` is present, it always contains start and end with all fields
+- If `tokenPosition` is not present, there might still be nested nodes that do contain a position
+- If `start == end`, the position refers to a single character
+- If `start &gt; end`, we know for sure that something was inserted.
 
 We can always check whether the canonical representation of a node matches the text in the tokenPosition to see whether
 something was inserted, removed, or changed.
@@ -177,93 +183,93 @@ something was inserted, removed, or changed.
 only present if it is true.
 
 Optional nodes can e.g. be optional braces that make a query more readable, but are not necessary. This could be used to
-enter *ghost braces* and *implicit functions* in the user's input field; maybe with different formatting
+enter _ghost braces_ and _implicit functions_ in the user's input field; maybe with different formatting
 (using the tokenPosition of sibling nodes we can also check whether the user wrote these or not).
 
 ### Advanced Token Types
 
 each node is of one of following types and may contain more fields:
 
-* Terminal Node
-* ContainerNode
-* Alternative Node
+- Terminal Node
+- ContainerNode
+- Alternative Node
 
 #### Terminal Node
 
 can be identified by checking whether `canonicalString` is present
 
-Field | Mandatory |  Description
------------------------- | --- | ---------------------------------------------------------------------------------------
-type                     | yes | the type of the terminal node - do not confuse with the type of container nodes
-canonicalString          | yes | the canonical string representation. Concatenating the canonicalString of all nested terminal nodes provides the canonical form of the query.
-isMandatoryOnUserOrder   | no  | may only be present if (`type="BRACE_OPEN"` or `type="BRACE_CLOSE"`) and `isOptional=true`. For usage see section [Special node type: PARAMETERS](#special-node-type-parameters)
+| Field                  | Mandatory | Description                                                                                                                                     |
+| ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| type                   | yes       | the type of the terminal node - do not confuse with the type of container nodes                                                                 |
+| canonicalString        | yes       | the canonical string representation. Concatenating the canonicalString of all nested terminal nodes provides the canonical form of the query.   |
+| isMandatoryOnUserOrder | no        | may only be present if (`type="BRACE_OPEN"` or `type="BRACE_CLOSE"`) and `isOptional=true`. For usage see section Special node type: PARAMETERS |
 
 ##### Current types of terminal nodes (list might grow):
 
-* SPACE
-* LINEBREAK
-* INDENT
-* PIPE
-* DOT
-* COLON
-* COMMA
-* BRACE_OPEN
-* BRACE_CLOSE
-* BRACKET_OPEN
-* BRACKET_CLOSE
-* PARENTHESIS_OPEN
-* PARENTHESIS_CLOSE
-* QUOTE
-* SLASH
-* BOOLEAN_TRUE
-* BOOLEAN_FALSE
-* NULL
-* COMMAND_NAME
-* PARAMETER_KEY
-* PARAMETER_VALUE_SCOPE
-* FUNCTION_NAME
-* OPERATOR
-* TRAVERSAL_OPERATOR
-* TRAVERSAL_RELATION_NAME
-* TRAVERSAL_HOP_COUNT
-* SIMPLE_IDENTIFIER
-* NUMBER
-* STRING
-* TIME_UNIT
-* TIMESTAMP_VALUE
-* METRIC_KEY
-* VARIABLE
+- SPACE
+- LINEBREAK
+- INDENT
+- PIPE
+- DOT
+- COLON
+- COMMA
+- BRACE_OPEN
+- BRACE_CLOSE
+- BRACKET_OPEN
+- BRACKET_CLOSE
+- PARENTHESIS_OPEN
+- PARENTHESIS_CLOSE
+- QUOTE
+- SLASH
+- BOOLEAN_TRUE
+- BOOLEAN_FALSE
+- NULL
+- COMMAND_NAME
+- PARAMETER_KEY
+- PARAMETER_VALUE_SCOPE
+- FUNCTION_NAME
+- OPERATOR
+- TRAVERSAL_OPERATOR
+- TRAVERSAL_RELATION_NAME
+- TRAVERSAL_HOP_COUNT
+- SIMPLE_IDENTIFIER
+- NUMBER
+- STRING
+- TIME_UNIT
+- TIMESTAMP_VALUE
+- METRIC_KEY
+- VARIABLE
 
 #### ContainerNode
 
 can be identified by checking whether `children` is present
 
-Field | Mandatory |  Description
------------------------ | --- | ----------------------------------------------------------------------------------------
-type                    | yes | the type of the container node - do not confuse with the type of terminal nodes
-children                | yes | the children for the node. might be of any type
+| Field    | Mandatory | Description                                                                     |
+| -------- | --------- | ------------------------------------------------------------------------------- |
+| type     | yes       | the type of the container node - do not confuse with the type of terminal nodes |
+| children | yes       | the children for the node. might be of any type                                 |
 
 ##### Current types of container nodes (list might grow):
 
-* QUERY
-* EXECUTION_BLOCK
-* COMMAND
-* COMMAND_SEPARATOR
-* PARAMETER_WITH_KEY
-* GROUP
-* PARAMETERS - check examples further down
-* PARAMETER_NAMING
-* PARAMETER_SEPARATOR
-* FUNCTION
-* FUNCTION_PART - check examples further down
-* EXPRESSION
-* IDENTIFIER
-* SOURCE_ID
-* DURATION
-* TIMESTAMP
-* TIMEFRAME
-* TRAVERSAL_PATH
-* TRAVERSAL_STEP
+- QUERY
+- EXECUTION_BLOCK
+- COMMAND
+- COMMAND_SEPARATOR
+- PARAMETER_WITH_KEY
+- GROUP
+- PARAMETERS - check examples further down
+- PARAMETER_NAMING
+- PARAMETER_SEPARATOR
+- FUNCTION
+- FUNCTION_PART - check examples further down
+- EXPRESSION
+- IDENTIFIER
+- SOURCE_ID
+- DURATION
+- TIMESTAMP
+- TIMEFRAME
+- TRAVERSAL_PATH
+- TRAVERSAL_STEP
 
 ##### Special node type: PARAMETERS
 
@@ -294,10 +300,10 @@ are only optional if `isOptional && !isMandatoryOnUserOrder`.
 
 A container node of type `FUNCTION` may contain nodes of type `FUNCTION_PART`.
 
-If those `FUNCTION_PART`s are marked as optional, this means you have to either include *all* or *none* of these
+If those `FUNCTION_PART`s are marked as optional, this means you have to either include _all_ or _none_ of these
 optional function parts.
 
-*Example*:
+_Example_:
 
 `filter anyMatch(a.b == 1, input:a)`
 
@@ -309,56 +315,45 @@ to an invalid query.
 
 can be identified by checking whether `alternatives` is present
 
-Field | Mandatory |  Description
------------------------ | --- | ----------------------------------------------------------------------------------------
-alternatives            | yes | Type: Map&lt;AlternativeType, DQLNode&gt;
+| Field        | Mandatory | Description                               |
+| ------------ | --------- | ----------------------------------------- |
+| alternatives | yes       | Type: Map&lt;AlternativeType, DQLNode&gt; |
 
 When displaying the query, pick one option. You may use the other options for hovering, replacing, and more.
 
 ##### Current values of AlternativeType (list might grow):
 
-* CANONICAL: This node is the one we will use for our canonical form
-* USER: An alternative that is also valid, but not canonical; and this version was picked by the user.
-* INFO: only if the canonical version is not present
+- CANONICAL: This node is the one we will use for our canonical form
+- USER: An alternative that is also valid, but not canonical; and this version was picked by the user.
+- INFO: only if the canonical version is not present
 
-*Examples*:
+_Examples_:
 
-* `CANONICAL` is not present, `USER` is present: user's nodes are optional, but not canonical (usually optional nodes
+- `CANONICAL` is not present, `USER` is present: user's nodes are optional, but not canonical (usually optional nodes
   are still canonical)
-* `CANONICAL` is present, `USER` is not present: same as if the canonical node was optional. If this happens, it is
+- `CANONICAL` is present, `USER` is not present: same as if the canonical node was optional. If this happens, it is
   likely that there is also an `INFO` node
-* `CANONICAL` is present, `USER` is present: there are different alternatives
-* `INFO` is present: usually if `CANONICAL` is not present (e.g. the parameter key for `FILTER a == 1`), there is an info node
+- `CANONICAL` is present, `USER` is present: there are different alternatives
+- `INFO` is present: usually if `CANONICAL` is not present (e.g. the parameter key for `FILTER a == 1`), there is an info node
   for `FILTER condition:a == 1`. This `condition:` was neither written by the user nor is it canonical; but it might be
   used to help the user understand what this parameter means.
 
-
 **Parameters**
 
 <div class="padding-left--md padding-bottom--md">
 <strong>config</strong>: Object
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -367,24 +362,15 @@ The authorization context. Typically start with 'Bearer '.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.body</strong>: <a href="#parserequest">ParseRequest</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
-
 #### Returns
 
 <div class="padding-left--md">
@@ -392,16 +378,26 @@ A node containing more nodes,  a node offering different (semantically equivalen
 
 </div>
 
+<details>
+<summary>
+Code example
 
+</summary>
 
+```ts
+import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
 
+const data = await queryAssistanceClient.queryParse({
+  authorization: "...",
+  body: {} as ParseRequest,
+});
+```
 
-</div>
-
-
+</details>
 
 </div>
 
+</div>
 
 ### queryVerify
 
@@ -419,33 +415,22 @@ For information about the required permissions see the [Bucket and table permiss
 Verifies the supplied query string and other query parameters for lack of any errors, but without actually
 submitting the query for execution.
 
-
 **Parameters**
 
 <div class="padding-left--md padding-bottom--md">
 <strong>config</strong>: Object
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -454,24 +439,15 @@ The authorization context. Typically start with 'Bearer '.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.body</strong>: <a href="#verifyrequest">VerifyRequest</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
-
 #### Returns
 
 <div class="padding-left--md">
@@ -479,26 +455,33 @@ Supplied query and parameters were verified.
 
 </div>
 
+<details>
+<summary>
+Code example
 
+</summary>
 
+```ts
+import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
 
+const data = await queryAssistanceClient.queryVerify({
+  authorization: "...",
+  body: {} as VerifyRequest,
+});
+```
 
-</div>
-
-
+</details>
 
 </div>
 
-
-
+</div>
 
 ## queryExecutionClient
 
 ```js
-import { queryExecutionClient } from '@dynatrace-sdk/client-query';
+import { queryExecutionClient } from "@dynatrace-sdk/client-query";
 ```
 
-
 ### queryCancel
 
 <div class="padding-bottom--md">
@@ -519,9 +502,10 @@ Cancels a running Grail query and returns a list of records if the query already
 If the query was already finished, a response body including the result will be returned. Otherwise the response will contain no body.
 
 The result has three main sections:
-* the 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
-* the 'types' section describes the corresponding data types that a record field has.
-* the 'metadata' section contains information about the query like 'analysisTimeframe', 'timezone' or 'locale'.
+
+- the 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+- the 'types' section describes the corresponding data types that a record field has.
+- the 'metadata' section contains information about the query like 'analysisTimeframe', 'timezone' or 'locale'.
 
 Every record has an implicit 'index' according to the position in the 'records' JSON array.
 The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
@@ -535,7 +519,6 @@ startIndex &lt;= i &lt;= endIndex
 
 Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
 
-
 Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
 field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
 When a collision does occur, we will create a new type 'bucket' that will have a different index range where
@@ -543,33 +526,22 @@ the new record field types will be placed.
 It is guaranteed that every field of every record will have a corresponding type.
 **Clients should always take the included types into account when consuming records!**
 
-
 **Parameters**
 
 <div class="padding-left--md padding-bottom--md">
 <strong>config</strong>: Object
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -578,12 +550,8 @@ The request-token of the query.
 
 </div>
 
-
-
 </div>
 
-
-
 #### Returns
 
 <div class="padding-left--md">
@@ -591,16 +559,25 @@ The query already finished.
 
 </div>
 
+<details>
+<summary>
+Code example
 
+</summary>
 
+```ts
+import { queryExecutionClient } from "@dynatrace-sdk/client-query";
 
+const data = await queryExecutionClient.queryCancel({
+  requestToken: "...",
+});
+```
 
-</div>
-
-
+</details>
 
 </div>
 
+</div>
 
 ### queryExecute
 
@@ -624,8 +601,9 @@ For details about the query language see the [Dynatrace Query Language documenta
 The json response will contain the state of the started query. If the query succeeded, the result will be included. Otherwise the response will contain a request token to reference the query in future polling requests.
 
 The result has two main sections:
-* The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
-* The 'types' section describes the corresponding data types that a record field has.
+
+- The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+- The 'types' section describes the corresponding data types that a record field has.
 
 Every record has an implicit 'index' according to the position in the 'records' JSON array.
 The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
@@ -639,7 +617,6 @@ startIndex &lt;= i &lt;= endIndex
 
 Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
 
-
 Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
 field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
 When a collision does occur, we will create a new type 'bucket' that will have a different index range where
@@ -647,33 +624,22 @@ the new record field types will be placed.
 It is guaranteed that every field of every record will have a corresponding type.
 **Clients should always take the included types into account when consuming records!**
 
-
 **Parameters**
 
 <div class="padding-left--md padding-bottom--md">
 <strong>config</strong>: Object
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -682,22 +648,14 @@ The authorization context. Typically start with 'Bearer '.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.body</strong>: <a href="#executerequest">ExecuteRequest</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -706,12 +664,8 @@ If set additional data will be available in the metadata section.
 
 </div>
 
-
-
 </div>
 
-
-
 #### Returns
 
 <div class="padding-left--md">
@@ -719,16 +673,27 @@ The final status and results of the supplied query if it finished within a suppl
 
 </div>
 
+<details>
+<summary>
+Code example
 
+</summary>
 
+```ts
+import { queryExecutionClient } from "@dynatrace-sdk/client-query";
 
+const data = await queryExecutionClient.queryExecute({
+  enrich: "metric-metadata",
+  authorization: "...",
+  body: {} as ExecuteRequest,
+});
+```
 
-</div>
-
-
+</details>
 
 </div>
 
+</div>
 
 ### queryPoll
 
@@ -746,11 +711,13 @@ For information about the required permissions see the [Bucket and table permiss
 Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
 
 ### The response format:
+
 The json response will contain the state of the query. If the query succeeded, the result will be included.
 
 The result has two main sections:
-* The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
-* The 'types' section describes the corresponding data types that a record field has.
+
+- The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+- The 'types' section describes the corresponding data types that a record field has.
 
 Every record has an implicit 'index' according to the position in the 'records' JSON array.
 The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
@@ -764,7 +731,6 @@ startIndex &lt;= i &lt;= endIndex
 
 Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
 
-
 Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
 field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
 When a collision does occur, we will create a new type 'bucket' that will have a different index range where
@@ -772,33 +738,22 @@ the new record field types will be placed.
 It is guaranteed that every field of every record will have a corresponding type.
 **Clients should always take the included types into account when consuming records!**
 
-
 **Parameters**
 
 <div class="padding-left--md padding-bottom--md">
 <strong>config</strong>: Object
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -807,10 +762,7 @@ If set additional data will be available in the metadata section.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -819,10 +771,7 @@ The time a client is willing to wait for the query result. In case the query fin
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -831,12 +780,8 @@ The request-token of the query.
 
 </div>
 
-
-
 </div>
 
-
-
 #### Returns
 
 <div class="padding-left--md">
@@ -844,40 +789,41 @@ The current status and results of the supplied query.
 
 </div>
 
+<details>
+<summary>
+Code example
 
+</summary>
 
+```ts
+import { queryExecutionClient } from "@dynatrace-sdk/client-query";
 
+const data = await queryExecutionClient.queryPoll({
+  requestToken: "...",
+  requestTimeoutMilliseconds: 60,
+  enrich: "metric-metadata",
+});
+```
 
-</div>
-
-
+</details>
 
 </div>
 
-
-
+</div>
 
 ## Types
 
 ### AutocompleteRequest
-<div class="padding-left--md">
-
-
-
 
+<div class="padding-left--md">
 
 <div class="padding-left--md padding-bottom--md">
 <strong>cursorPosition</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -886,10 +832,7 @@ The query locale. If none specified, then a language/country neutral locale is c
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -898,10 +841,7 @@ The full query string.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -910,19 +850,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### AutocompleteResponse
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The response of the autocomplete call.
 
@@ -934,10 +868,7 @@ True if the suggestions are optional.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>suggestedTtlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -946,10 +877,7 @@ Suggested duration in seconds, for how long the response may be cached and reuse
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>suggestions</strong>: Array&lt;<a href="#autocompletesuggestion">AutocompleteSuggestion</a>&gt;
 <div class="padding-left--md">
@@ -958,19 +886,13 @@ The list of suggestions.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### AutocompleteSuggestion
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Single suggestion for completion of the query.
 
@@ -982,10 +904,7 @@ Number of characters that the user user already typed for this suggestion.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>parts</strong>: Array&lt;<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>&gt;
 <div class="padding-left--md">
@@ -994,10 +913,7 @@ List of suggestion parts.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1006,19 +922,13 @@ The suggested continuation of the query.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### AutocompleteSuggestionPart
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Part of the suggestion.
 
@@ -1030,10 +940,7 @@ The type of the suggestion.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1042,10 +949,7 @@ The suggested continuation of the query.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>synopsis</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1054,31 +958,20 @@ The synopsis of the suggestion.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>type</strong>: <a href="#tokentype">TokenType</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### DQLAlternativeNode
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The DQL node that has alternatives.
 
@@ -1090,10 +983,7 @@ The different alternatives.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>isOptional</strong>: boolean
 <div class="padding-left--md">
@@ -1102,43 +992,27 @@ True if the node is optional.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### DQLContainerNode
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The DQL node that contains other nodes.
 
@@ -1150,10 +1024,7 @@ The list of children nodes.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>isOptional</strong>: boolean
 <div class="padding-left--md">
@@ -1162,34 +1033,21 @@ True if the node is optional.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>type</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1198,19 +1056,13 @@ The type of the node.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### DQLNode
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 General Node in the DQL query.
 
@@ -1222,43 +1074,27 @@ True if the node is optional.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### DQLTerminalNode
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Node that represents single token.
 
@@ -1270,10 +1106,7 @@ Canonical form.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>isMandatoryOnUserOrder</strong>: boolean
 <div class="padding-left--md">
@@ -1282,10 +1115,7 @@ For optional items only: whether this node becomes mandatory when user order is
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>isOptional</strong>: boolean
 <div class="padding-left--md">
@@ -1294,55 +1124,34 @@ True if the node is optional.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>type</strong>: <a href="#tokentype">TokenType</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### ErrorEnvelope
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 An 'envelope' error object that has the mandatory error object.
 
@@ -1350,23 +1159,15 @@ An 'envelope' error object that has the mandatory error object.
 <strong>error</strong>: <a href="#errorresponse">ErrorResponse</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### ErrorResponse
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The response for error state
 
@@ -1378,22 +1179,14 @@ Error code, which normally matches the HTTP error code.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>details</strong>: <a href="#errorresponsedetails">ErrorResponseDetails</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1402,19 +1195,13 @@ A short, clear error message without details
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### ErrorResponseDetails
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Detailed information about the error.
 
@@ -1426,10 +1213,7 @@ The arguments for the message format.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>errorMessage</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1438,10 +1222,7 @@ Complete error message.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>errorMessageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1450,10 +1231,7 @@ The message format of the error message, string.format based.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>errorMessageFormatSpecifierTypes</strong>: Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt;
 <div class="padding-left--md">
@@ -1462,10 +1240,7 @@ The corresponding DQL format specifier types for each format specifier used in t
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>errorType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1474,10 +1249,7 @@ The error type, e.g. COMMAND_NAME_MISSING
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>exceptionType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1486,10 +1258,7 @@ The exception type.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>queryString</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1498,33 +1267,20 @@ Submitted query string.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>syntaxErrorPosition</strong>: <a href="#tokenposition">TokenPosition</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### ExecuteRequest
-<div class="padding-left--md">
-
-
-
 
+<div class="padding-left--md">
 
 <div class="padding-left--md padding-bottom--md">
 <strong>defaultSamplingRatio</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
@@ -1534,10 +1290,7 @@ In case not specified in the DQL string, the sampling ratio defined here is appl
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>defaultScanLimitGbytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -1546,34 +1299,25 @@ Limit in gigabytes for the amount data that will be scanned during read.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>defaultTimeframeEnd</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
 
-The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. *Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.*
+The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. _Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter._
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>defaultTimeframeStart</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
 
-The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. *Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.*
+The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. _Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter._
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>enablePreview</strong>: boolean
 <div class="padding-left--md">
@@ -1582,10 +1326,7 @@ Request preview results. If a preview is available within the requestTimeoutMill
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>fetchTimeoutSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -1594,10 +1335,7 @@ The query will stop after reaching the fetch-timeout.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1606,10 +1344,7 @@ The query locale. If none specified, then a language/country neutral locale is c
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>maxResultRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -1618,10 +1353,7 @@ The maximum number of result records that this query will return.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1630,10 +1362,7 @@ The full query string.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -1642,10 +1371,7 @@ The time a client is willing to wait for the query result. In case the query fin
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1654,19 +1380,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### FieldType
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The possible type of a field in DQL.
 
@@ -1674,35 +1394,22 @@ The possible type of a field in DQL.
 <strong>type</strong>: <a href="#fieldtypetype">FieldTypeType</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>types</strong>: Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### GeoPoint
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 DQL data type representing a geolocation point.
 
@@ -1714,31 +1421,22 @@ The coordinate that specifies the north–south position of a point on the surfa
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>longitude</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
 
-The coordinate that specifies the  east–west position of a point on the surface of the earth.
+The coordinate that specifies the east–west position of a point on the surface of the earth.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### GrailMetadata
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Collects various bits of metadata information.
 
@@ -1746,14 +1444,9 @@ Collects various bits of metadata information.
 <strong>analysisTimeframe</strong>: <a href="#timeframe">Timeframe</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>canonicalQuery</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1762,10 +1455,7 @@ The canonical form of the query. It has normalized spaces and canonical construc
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>dqlVersion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1774,10 +1464,7 @@ The version of DQL that was used to process the query request.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>executionTimeMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -1786,10 +1473,7 @@ The time it took to execute the query.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1798,10 +1482,7 @@ Effective locale for the query.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>notifications</strong>: Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;
 <div class="padding-left--md">
@@ -1810,10 +1491,7 @@ Collected messages during the execution of the query.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1822,10 +1500,7 @@ The submitted query.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>queryId</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1834,10 +1509,7 @@ The id of the query
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>sampled</strong>: boolean
 <div class="padding-left--md">
@@ -1846,10 +1518,7 @@ True if sampling was used for at least one segment.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>scannedBytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -1858,10 +1527,7 @@ Number of scanned bytes during the query execution.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>scannedRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -1870,10 +1536,7 @@ Number of scanned records during the query execution.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1882,19 +1545,13 @@ Effective timezone for the query.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### Metadata
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Collects various bits of metadata information.
 
@@ -1902,35 +1559,22 @@ Collects various bits of metadata information.
 <strong>grail</strong>: <a href="#grailmetadata">GrailMetadata</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>metrics</strong>: Array&lt;<a href="#metricmetadata">MetricMetadata</a>&gt;
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### MetadataNotification
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The message that provides additional information about the execution of the query.
 
@@ -1942,10 +1586,7 @@ The arguments for the message format.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1954,10 +1595,7 @@ The complete message of the notification.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>messageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1966,10 +1604,7 @@ The message format of the notification, string.format based
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>messageFormatSpecifierTypes</strong>: Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt;
 <div class="padding-left--md">
@@ -1978,10 +1613,7 @@ The corresponding DQL format specifier types for each format specifier used in t
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>notificationType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -1990,10 +1622,7 @@ The notification type, e.g. LIMIT_ADDED.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>severity</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2002,31 +1631,20 @@ The severity of the notification, currently: INFO, WARN, ERROR.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>syntaxPosition</strong>: <a href="#tokenposition">TokenPosition</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### MetricMetadata
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 An object that defines additional metric metadata.
 
@@ -2038,10 +1656,7 @@ The description of the metadata.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>displayName</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2050,10 +1665,16 @@ The display name of the metadata.
 
 </div>
 
+</div>
+<div class="padding-left--md padding-bottom--md">
+<strong>fieldName</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
 
+The name of the associated field used in the query.
 
 </div>
 
+</div>
 <div class="padding-left--md padding-bottom--md">
 <strong>metric.key</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2062,10 +1683,7 @@ The metric key.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>unit</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2074,21 +1692,13 @@ The unit used.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### ParseRequest
-<div class="padding-left--md">
-
-
-
 
+<div class="padding-left--md">
 
 <div class="padding-left--md padding-bottom--md">
 <strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
@@ -2098,10 +1708,7 @@ The query locale. If none specified, then a language/country neutral locale is c
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2110,10 +1717,7 @@ The full query string.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2122,19 +1726,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### PositionInfo
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The exact position in the query string.
 
@@ -2146,10 +1744,7 @@ Query position column zero based index.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>index</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -2158,10 +1753,7 @@ Query position index.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>line</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -2170,19 +1762,13 @@ Query position line zero based index.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### QueryPollResponse
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The response of GET query:execute call.
 
@@ -2194,34 +1780,21 @@ The progress of the query from 0 to 100.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>result</strong>: <a href="#queryresult">QueryResult</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>state</strong>: <a href="#querystate">QueryState</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -2230,19 +1803,13 @@ Time to live in seconds.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### QueryResult
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The result of the DQL query.
 
@@ -2250,14 +1817,9 @@ The result of the DQL query.
 <strong>metadata</strong>: <a href="#metadata">Metadata</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>records</strong>: Array&lt;null | <a href="#resultrecord">ResultRecord</a>&gt;
 <div class="padding-left--md">
@@ -2266,10 +1828,7 @@ List of records containing the result fields data.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>types</strong>: Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;
 <div class="padding-left--md">
@@ -2278,19 +1837,13 @@ The data types for the result records.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### QueryStartResponse
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The response when starting a query.
 
@@ -2302,10 +1855,7 @@ The progress of the query from 0 to 100.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2314,34 +1864,21 @@ The token returned by the POST query:execute call.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>result</strong>: <a href="#queryresult">QueryResult</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>state</strong>: <a href="#querystate">QueryState</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
@@ -2350,19 +1887,13 @@ Time to live in seconds.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### RangedFieldTypes
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The field type in range.
 
@@ -2374,57 +1905,36 @@ The range of elements at use this type in arrays (null for records).
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>mappings</strong>: <a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### RangedFieldTypesMappings
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The mapping between the field name and data type.
 
-
-
 </div>
 
-
-
 ### ResultRecord
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Single record that contains the result fields.
 
-
-
 </div>
 
-
-
 ### Timeframe
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 DQL data type timeframe.
 
@@ -2436,10 +1946,7 @@ The end time of the timeframe.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>start</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>
 <div class="padding-left--md">
@@ -2448,19 +1955,13 @@ The start time of the timeframe.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### TokenPosition
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
 
@@ -2468,37 +1969,22 @@ The position of a token in a query string used for errors and notification to ma
 <strong>end</strong>: <a href="#positioninfo">PositionInfo</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>start</strong>: <a href="#positioninfo">PositionInfo</a>
 <div class="padding-left--md">
 
-
-
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### VerifyRequest
-<div class="padding-left--md">
-
-
-
 
+<div class="padding-left--md">
 
 <div class="padding-left--md padding-bottom--md">
 <strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
@@ -2508,10 +1994,7 @@ The query locale. If none specified, then a language/country neutral locale is c
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2520,10 +2003,7 @@ The full query string.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
@@ -2532,19 +2012,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
 ### VerifyResponse
-<div class="padding-left--md">
-
 
+<div class="padding-left--md">
 
 Verify response.
 
@@ -2556,10 +2030,7 @@ The notifications related to the supplied DQL query string.
 
 </div>
 
-
-
 </div>
-
 <div class="padding-left--md padding-bottom--md">
 <strong>valid</strong>: boolean
 <div class="padding-left--md">
@@ -2568,19 +2039,12 @@ True if the supplied DQL query string is valid.
 
 </div>
 
-
-
 </div>
 
-
 </div>
 
-
-
-
 ## Enums
 
-
 ### DQLNodeNodeType
 
 <div class="padding-left--md">
@@ -2595,18 +2059,12 @@ The type of the node.
 
 </div>
 
-
 </div>
 
-
-
-
 ### FieldTypeType
 
 <div class="padding-left--md">
 
-
-
 #### Enum keys
 
 <div class="padding-left--md">
@@ -2615,12 +2073,8 @@ The type of the node.
 
 </div>
 
-
 </div>
 
-
-
-
 ### QueryState
 
 <div class="padding-left--md">
@@ -2635,12 +2089,8 @@ Possible state of the query.
 
 </div>
 
-
 </div>
 
-
-
-
 ### TokenType
 
 <div class="padding-left--md">
@@ -2655,9 +2105,4 @@ The type of the autocomplete token.
 
 </div>
 
-
 </div>
-
-
-
-