@dynatrace-sdk/client-query 1.10.1 → 1.11.1

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.10.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.10.1)
+[![npm](https://img.shields.io/badge/npm-v1.11.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.11.1)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Exposes an API to fetch records stored in Grail
@@ -35,10 +35,11 @@ import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
 ```
 
 
+<a name="queryautocomplete"></a>
 ### queryAutocomplete
 
 <div class="padding-bottom--md">
-<strong>queryAssistanceClient.queryAutocomplete(config): Promise&lt;[AutocompleteResponse](#autocompleteresponse)&gt;</strong>
+<strong>queryAssistanceClient.queryAutocomplete(config): Promise&lt;<a href="#autocompleteresponse">AutocompleteResponse</a>&gt;</strong>
 
 <div class="padding-left--md">
 
@@ -87,10 +88,9 @@ a link to docs, etc.
 
 #### Parameters
 
-| Name | Type| Description|
-|---|---|---|
-|config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
-|config.body<sup>*required</sup>|[AutocompleteRequest](#autocompleterequest)| |
+| Name | Type |
+| --- | --- |
+|config.body<sup>*required</sup>|<a href="#autocompleterequest" target="_blank" rel="noopener noreferrer">AutocompleteRequest</a>| 
 
 
 
@@ -103,7 +103,6 @@ A list of structured autocomplete suggestions.
 <details>
 <summary>
 Code example
-
 </summary>
 
 ```ts
@@ -124,10 +123,11 @@ const data = await queryAssistanceClient.queryAutocomplete({
 </div>
 
 
+<a name="queryparse"></a>
 ### queryParse
 
 <div class="padding-bottom--md">
-<strong>queryAssistanceClient.queryParse(config): Promise&lt;[DQLNode](#dqlnode)&gt;</strong>
+<strong>queryAssistanceClient.queryParse(config): Promise&lt;<a href="#dqlnode">DQLNode</a>&gt;</strong>
 
 <div class="padding-left--md">
 
@@ -332,10 +332,9 @@ When displaying the query, pick one option. You may use the other options for ho
 
 #### Parameters
 
-| Name | Type| Description|
-|---|---|---|
-|config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
-|config.body<sup>*required</sup>|[ParseRequest](#parserequest)| |
+| Name | Type |
+| --- | --- |
+|config.body<sup>*required</sup>|<a href="#parserequest" target="_blank" rel="noopener noreferrer">ParseRequest</a>| 
 
 
 
@@ -348,7 +347,6 @@ A node containing more nodes,  a node offering different (semantically equivalen
 <details>
 <summary>
 Code example
-
 </summary>
 
 ```ts
@@ -369,10 +367,11 @@ const data = await queryAssistanceClient.queryParse({
 </div>
 
 
+<a name="queryverify"></a>
 ### queryVerify
 
 <div class="padding-bottom--md">
-<strong>queryAssistanceClient.queryVerify(config): Promise&lt;[VerifyResponse](#verifyresponse)&gt;</strong>
+<strong>queryAssistanceClient.queryVerify(config): Promise&lt;<a href="#verifyresponse">VerifyResponse</a>&gt;</strong>
 
 <div class="padding-left--md">
 
@@ -392,10 +391,9 @@ submitting the query for execution.
 
 #### Parameters
 
-| Name | Type| Description|
-|---|---|---|
-|config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
-|config.body<sup>*required</sup>|[VerifyRequest](#verifyrequest)| |
+| Name | Type |
+| --- | --- |
+|config.body<sup>*required</sup>|<a href="#verifyrequest" target="_blank" rel="noopener noreferrer">VerifyRequest</a>| 
 
 
 
@@ -408,7 +406,6 @@ Supplied query and parameters were verified.
 <details>
 <summary>
 Code example
-
 </summary>
 
 ```ts
@@ -435,10 +432,11 @@ import { queryExecutionClient } from '@dynatrace-sdk/client-query';
 ```
 
 
+<a name="querycancel"></a>
 ### queryCancel
 
 <div class="padding-bottom--md">
-<strong>queryExecutionClient.queryCancel(config): Promise&lt;void &#124; [QueryPollResponse](#querypollresponse)&gt;</strong>
+<strong>queryExecutionClient.queryCancel(config): Promise&lt;void &#124; <a href="#querypollresponse">QueryPollResponse</a>&gt;</strong>
 
 <div class="padding-left--md">
 
@@ -486,8 +484,8 @@ It is guaranteed that every field of every record will have a corresponding type
 
 #### Parameters
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
 |config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
 
@@ -502,7 +500,6 @@ The query already finished.
 <details>
 <summary>
 Code example
-
 </summary>
 
 ```ts
@@ -520,10 +517,11 @@ const data = await queryExecutionClient.queryCancel({
 </div>
 
 
+<a name="queryexecute"></a>
 ### queryExecute
 
 <div class="padding-bottom--md">
-<strong>queryExecutionClient.queryExecute(config): Promise&lt;[QueryStartResponse](#querystartresponse)&gt;</strong>
+<strong>queryExecutionClient.queryExecute(config): Promise&lt;<a href="#querystartresponse" target="_blank" rel="noopener noreferrer">QueryStartResponse</a>&gt;</strong>
 
 <div class="padding-left--md">
 
@@ -572,10 +570,9 @@ It is guaranteed that every field of every record will have a corresponding type
 
 #### Parameters
 
-| Name | Type| Description|
-|---|---|---|
-|config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
-|config.body<sup>*required</sup>|[ExecuteRequest](#executerequest)| |
+| Name | Type | Description |
+| --- | --- | --- |
+|config.body<sup>*required</sup>|<a href="#executerequest">ExecuteRequest</a>| |
 |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
 
 
@@ -589,7 +586,6 @@ The final status and results of the supplied query if it finished within a suppl
 <details>
 <summary>
 Code example
-
 </summary>
 
 ```ts
@@ -610,10 +606,11 @@ const data = await queryExecutionClient.queryExecute({
 </div>
 
 
+<a name="querypoll"></a>
 ### queryPoll
 
 <div class="padding-bottom--md">
-<strong>queryExecutionClient.queryPoll(config): Promise&lt;[QueryPollResponse](#querypollresponse)&gt;</strong>
+<strong>queryExecutionClient.queryPoll(config): Promise&lt;<a href="#querypollresponse" target="_blank" rel="noopener noreferrer">QueryPollResponse</a>&gt;</strong>
 
 <div class="padding-left--md">
 
@@ -659,8 +656,8 @@ It is guaranteed that every field of every record will have a corresponding type
 
 #### Parameters
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
 |config.requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the query status is returned. |
 |config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
@@ -676,7 +673,6 @@ The current status and results of the supplied query.
 <details>
 <summary>
 Code example
-
 </summary>
 
 ```ts
@@ -701,47 +697,51 @@ const data = await queryExecutionClient.queryPoll({
 
 
 
-| Name | Type| Description|
-|---|---|---|
+
+| Name | Type | Description |
+| --- | --- | --- |
 |cursorPosition|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
 |maxDataSuggestions|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|[QueryOptions](#queryoptions)| |
+|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
 ### AutocompleteResponse
 
 
 
+
 The response of the autocomplete call.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |optional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the suggestions are optional. |
 |suggestedTtlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Suggested duration in seconds, for how long the response may be cached and reused by the client. It is derived from the volatility of the suggestions on the server (if the suggestions are static, how long the server will cache the volatile suggestions, ...). If not provided, then the result may be cached for long time. Value below 1 means that the result should not be cached. |
-|suggestions<sup>*required</sup>|Array&lt;[AutocompleteSuggestion](#autocompletesuggestion)&gt;|The list of suggestions. |
+|suggestions<sup>*required</sup>|Array&lt;<a href="#autocompletesuggestion" target="_blank" rel="noopener noreferrer">AutocompleteSuggestion</a>&gt;|The list of suggestions. |
 
 ### AutocompleteSuggestion
 
 
 
+
 Single suggestion for completion of the query.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |alreadyTypedCharacters<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of characters that the user user already typed for this suggestion. |
-|parts<sup>*required</sup>|Array&lt;[AutocompleteSuggestionPart](#autocompletesuggestionpart)&gt;|List of suggestion parts. |
+|parts<sup>*required</sup>|Array&lt;<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>&gt;|List of suggestion parts. |
 |suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
 
 ### AutocompleteSuggestionPart
 
 
 
+
 Part of the suggestion.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |info|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the suggestion. |
 |suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
 |synopsis|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The synopsis of the suggestion. |
@@ -751,86 +751,93 @@ Part of the suggestion.
 
 
 
+
 The DQL node that has alternatives.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |alternatives|object|The different alternatives. |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
 |nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|[TokenPosition](#tokenposition)| |
+|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
 
 ### DQLContainerNode
 
 
 
+
 The DQL node that contains other nodes.
 
-| Name | Type| Description|
-|---|---|---|
-|children|Array&lt;[DQLNode](#dqlnode)&gt;|The list of children nodes. |
+| Name | Type | Description |
+| --- | --- | --- |
+|children|Array&lt;<a href="#dqlnode">DQLNode</a>&gt;|The list of children nodes. |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
 |nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|[TokenPosition](#tokenposition)| |
+|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
 |type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the node. |
 
 ### DQLNode
 
 
 
+
 General Node in the DQL query.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
 |nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|[TokenPosition](#tokenposition)| |
+|tokenPosition|<a href="#tokenposition">TokenPosition</a>| |
 
 ### DQLTerminalNode
 
 
 
+
 Node that represents single token.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |canonicalString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Canonical form. |
 |isMandatoryOnUserOrder|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces' |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
 |nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|[TokenPosition](#tokenposition)| |
+|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
 |type|TokenType| |
 
 ### ErrorEnvelope
 
 
 
+
 An &apos;envelope&apos; error object that has the mandatory error object.
 
-| Name | Type|
-|---|---|
-|error<sup>*required</sup>|[ErrorResponse](#errorresponse)|
+| Name | Type |
+| --- | --- |
+|error<sup>*required</sup>|<a href="#errorresponse">ErrorResponse</a>|
 
 ### ErrorResponse
 
 
 
+
 The response for error state
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Error code, which normally matches the HTTP error code. |
-|details<sup>*required</sup>|[ErrorResponseDetails](#errorresponsedetails)| |
+|details<sup>*required</sup>|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>| |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
 
 ### ErrorResponseDetails
 
 
 
+
 Detailed information about the error.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |arguments<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The arguments for the message format. |
 |errorMessage<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Complete error message. |
 |errorMessageFormat<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the error message, string.format based. |
@@ -839,7 +846,7 @@ Detailed information about the error.
 |exceptionType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The exception type. |
 |queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
 |queryString<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Submitted query string. |
-|syntaxErrorPosition|[TokenPosition](#tokenposition)| |
+|syntaxErrorPosition|<a href="#tokenposition">TokenPosition</a>| |
 
 ### ExecuteRequest
 
@@ -847,19 +854,20 @@ Detailed information about the error.
 
 
 
-| Name | Type| Description|
-|---|---|---|
+
+| Name | Type | Description |
+| --- | --- | --- |
 |defaultSamplingRatio|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries. |
 |defaultScanLimitGbytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Limit in gigabytes for the amount data that will be scanned during read. |
-|defaultTimeframeEnd|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
-|defaultTimeframeStart|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
+|defaultTimeframeEnd|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'end' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
+|defaultTimeframeStart|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'start' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
 |enablePreview|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response. |
 |fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The query will stop reading data after reaching the fetch-timeout. The query execution will continue, providing a partial result based on the read data. |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
 |maxResultBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result bytes that this query will return. |
 |maxResultRecords|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result records that this query will return. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|[QueryOptions](#queryoptions)| |
+|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
 |requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result. |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
@@ -867,21 +875,23 @@ Detailed information about the error.
 
 
 
+
 The possible type of a field in DQL.
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |type<sup>*required</sup>|FieldTypeType| 
-|types|Array&lt;[RangedFieldTypes](#rangedfieldtypes)&gt;|
+|types|Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;|
 
 ### GeoPoint
 
 
 
+
 DQL data type representing a geolocation point.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |latitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The coordinate that specifies the north-south position of a point on the surface of the earth. |
 |longitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The coordinate that specifies the  east-west position of a point on the surface of the earth. |
 
@@ -889,16 +899,17 @@ DQL data type representing a geolocation point.
 
 
 
+
 Collects various bits of metadata information.
 
-| Name | Type| Description|
-|---|---|---|
-|analysisTimeframe|[Timeframe](#timeframe)| |
+| Name | Type | Description |
+| --- | --- | --- |
+|analysisTimeframe|<a href="#timeframe" target="_blank" rel="noopener noreferrer">Timeframe</a>| |
 |canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The canonical form of the query. It has normalized spaces and canonical constructs. |
 |dqlVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of DQL that was used to process the query request. |
 |executionTimeMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time it took to execute the query. |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Effective locale for the query. |
-|notifications|Array&lt;[MetadataNotification](#metadatanotification)&gt;|Collected messages during the execution of the query. |
+|notifications|Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;|Collected messages during the execution of the query. |
 |query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The submitted query. |
 |queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the query |
 |sampled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if sampling was used for at least one segment. |
@@ -911,37 +922,40 @@ Collects various bits of metadata information.
 
 
 
+
 Collects various bits of metadata information.
 
-| Name | Type|
-|---|---|
-|grail|[GrailMetadata](#grailmetadata)| 
-|metrics|Array&lt;[MetricMetadata](#metricmetadata)&gt;|
+| Name | Type |
+| --- | --- |
+|grail|<a href="#grailmetadata" target="_blank" rel="noopener noreferrer">GrailMetadata</a>| 
+|metrics|Array&lt;<a href="#metricmetadata">MetricMetadata</a>&gt;|
 
 ### MetadataNotification
 
 
 
+
 The message that provides additional information about the execution of the query.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |arguments|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The arguments for the message format. |
 |message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The complete message of the notification. |
 |messageFormat|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the notification, string.format based |
 |messageFormatSpecifierTypes|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The corresponding DQL format specifier types for each format specifier used in the error message format. |
 |notificationType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The notification type, e.g. LIMIT_ADDED. |
 |severity|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The severity of the notification, currently: INFO, WARN, ERROR. |
-|syntaxPosition|[TokenPosition](#tokenposition)| |
+|syntaxPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
 
 ### MetricMetadata
 
 
 
+
 An object that defines additional metric metadata.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the metadata. |
 |displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the metadata. |
 |fieldName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the associated field used in the query. |
@@ -957,26 +971,29 @@ An object that defines additional metric metadata.
 
 
 
-| Name | Type| Description|
-|---|---|---|
+
+| Name | Type | Description |
+| --- | --- | --- |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|[QueryOptions](#queryoptions)| |
+|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
 ### PositionInfo
 
 
 
+
 The exact position in the query string.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |column<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Query position column zero based index. |
 |index<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Query position index. |
 |line<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Query position line zero based index. |
 
 ### QueryOptions
+**type**: Record&lt;string, string | undefined&gt;
 
 
 
@@ -986,12 +1003,13 @@ Query options.
 
 
 
+
 The response of GET query:execute call.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
-|result|[QueryResult](#queryresult)| |
+|result|<a href="#queryresult" target="_blank" rel="noopener noreferrer">QueryResult</a>| |
 |state<sup>*required</sup>|QueryState| |
 |ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
 
@@ -999,25 +1017,27 @@ The response of GET query:execute call.
 
 
 
+
 The result of the DQL query.
 
-| Name | Type| Description|
-|---|---|---|
-|metadata<sup>*required</sup>|[Metadata](#metadata)| |
-|records<sup>*required</sup>|Array&lt;null &#124; [ResultRecord](#resultrecord)&gt;|List of records containing the result fields data. |
-|types<sup>*required</sup>|Array&lt;[RangedFieldTypes](#rangedfieldtypes)&gt;|The data types for the result records. |
+| Name | Type | Description |
+| --- | --- | --- |
+|metadata<sup>*required</sup>|<a href="#metadata">Metadata</a>| |
+|records<sup>*required</sup>|Array&lt;null &#124; <a href="#resultrecord" target="_blank" rel="noopener noreferrer">ResultRecord</a>&gt;|List of records containing the result fields data. |
+|types<sup>*required</sup>|Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;|The data types for the result records. |
 
 ### QueryStartResponse
 
 
 
+
 The response when starting a query.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
 |requestToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The token returned by the POST query:execute call. |
-|result|[QueryResult](#queryresult)| |
+|result|<a href="#queryresult" target="_blank" rel="noopener noreferrer">QueryResult</a>| |
 |state<sup>*required</sup>|QueryState| |
 |ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
 
@@ -1025,20 +1045,23 @@ The response when starting a query.
 
 
 
+
 The field type in range.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |indexRange|Array&lt;[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)&gt;|The range of elements at use this type in arrays (null for records). |
-|mappings<sup>*required</sup>|[RangedFieldTypesMappings](#rangedfieldtypesmappings)| |
+|mappings<sup>*required</sup>|<a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a>| |
 
 ### RangedFieldTypesMappings
+**type**: Record&lt;string, FieldType | undefined&gt;
 
 
 
 The mapping between the field name and data type.
 
 ### ResultRecord
+**type**: Record&lt;string, ResultRecordValue | null | undefined&gt;
 
 
 
@@ -1048,10 +1071,11 @@ Single record that contains the result fields.
 
 
 
+
 DQL data type timeframe.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |end|Date|The end time of the timeframe. |
 |start|Date|The start time of the timeframe. |
 
@@ -1059,12 +1083,13 @@ DQL data type timeframe.
 
 
 
+
 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.
 
-| Name | Type|
-|---|---|
-|end<sup>*required</sup>|[PositionInfo](#positioninfo)| 
-|start<sup>*required</sup>|[PositionInfo](#positioninfo)|
+| Name | Type |
+| --- | --- |
+|end<sup>*required</sup>|<a href="#positioninfo" target="_blank" rel="noopener noreferrer">PositionInfo</a>| 
+|start<sup>*required</sup>|<a href="#positioninfo">PositionInfo</a>|
 
 ### VerifyRequest
 
@@ -1072,26 +1097,31 @@ The position of a token in a query string used for errors and notification to ma
 
 
 
-| Name | Type| Description|
-|---|---|---|
+
+| Name | Type | Description |
+| --- | --- | --- |
+|generateCanonicalQuery|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| <i>default:</i> <code>false</code>|
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|[QueryOptions](#queryoptions)| |
+|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
 ### VerifyResponse
 
 
 
+
 Verify response.
 
-| Name | Type| Description|
-|---|---|---|
-|notifications|Array&lt;[MetadataNotification](#metadatanotification)&gt;|The notifications related to the supplied DQL query string. |
+| Name | Type | Description |
+| --- | --- | --- |
+|canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
+|notifications|Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;|The notifications related to the supplied DQL query string. |
 |valid<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the supplied DQL query string is valid. |
 
 ## Enums
 
+<a name="dqlnodenodetype"></a>
 ### DQLNodeNodeType
 
 <div class="padding-left--md">
@@ -1109,6 +1139,7 @@ The type of the node.
 
 </div>
 
+<a name="fieldtypetype"></a>
 ### FieldTypeType
 
 <div class="padding-left--md">
@@ -1126,6 +1157,7 @@ The type of the node.
 
 </div>
 
+<a name="querystate"></a>
 ### QueryState
 
 <div class="padding-left--md">
@@ -1143,6 +1175,7 @@ Possible state of the query.
 
 </div>
 
+<a name="tokentype"></a>
 ### TokenType
 
 <div class="padding-left--md">