@dynatrace-sdk/client-query 1.21.2 → 1.22.1

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 @dynatrace-sdk/client-query
 
+## 1.22.1
+
+Patch Changes
+- Improve description of query-api spec
+
+## 1.22.0
+
+### Minor Changes
+
+- Add new token types to the `TokenType` enum
+- Add new body parameter `includeContributions` to indicate whether contribution information should be included in the query response metadata.
+
+## 1.21.3
+
+### Patch Changes
+
+- Replace HTML tags with Markdown
+- Improve some descriptions for query-api spec
+
 ## 1.21.2
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.21.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.21.2)
+[![npm](https://img.shields.io/badge/npm-v1.22.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.22.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
@@ -315,7 +315,7 @@ can be identified by checking whether `alternatives` is present
 
 Field | Mandatory |  Description
 ----------------------- | --- | ----------------------------------------------------------------------------------------
-alternatives            | yes | Type: Map<AlternativeType, DQLNode>
+alternatives            | yes | Type: Map<AlternativeType, DQLNode>
 
 When displaying the query, pick one option. You may use the other options for hovering, replacing, and more.
 
@@ -713,7 +713,7 @@ It is guaranteed that every field of every record will have a corresponding type
 | --- | --- | --- |
 |config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
 |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.requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time the response is allowed to be delayed for either a preview or the final result to become available. No default value (immediate response). |
 |config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
 
 
@@ -758,10 +758,10 @@ const data = await queryExecutionClient.queryPoll({
 
 | Name | Type | Description |
 | --- | --- | --- |
-|cursorPosition|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
+|cursorPosition|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|No upper limit but must be lower than length of query. No default value. |
 |enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean to indicate if the query consumption limit should be enforced |
 |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)| |
+|maxDataSuggestions|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Limit the number of data suggestions, such as field names. No upper limit. No default value. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
 |queryOptions|<a href="#queryoptions">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
 |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' |
@@ -795,7 +795,22 @@ Part of the suggestion.
 |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. |
-|type<sup>*required</sup>|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "TABULAR_FILE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE" &#124; "ENUM_STRING" &#124; "FIELD_PREFIX" &#124; "BUCKET" &#124; "SMARTSCAPE_NODE_PATTERN" &#124; "SMARTSCAPE_EDGE_PATTERN" &#124; "SMARTSCAPE_NODE_TYPE" &#124; "SMARTSCAPE_EDGE_TYPE"|The type of the autocomplete token. |
+|type<sup>*required</sup>|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "TABULAR_FILE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE" &#124; "ENUM_STRING" &#124; "FIELD_PREFIX" &#124; "BUCKET" &#124; "SMARTSCAPE_NODE_PATTERN" &#124; "SMARTSCAPE_EDGE_PATTERN" &#124; "SMARTSCAPE_NODE_TYPE" &#124; "SMARTSCAPE_EDGE_TYPE" &#124; "JSON_PATH" &#124; "URL"|The type of the autocomplete token. |
+
+### BucketContribution
+
+| Name | Type |
+| --- | --- |
+|matchedRecordsRatio|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| 
+|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| 
+|scannedBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| 
+|table|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
+
+### Contributions
+
+| Name | Type |
+| --- | --- |
+|buckets|Array&lt;<a href="#bucketcontribution" target="_blank" rel="noopener noreferrer">BucketContribution</a>&gt;|
 
 ### DQLAlternativeNode
 
@@ -803,10 +818,10 @@ The DQL node that has alternatives.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|alternatives|object|The different alternatives. |
+|alternatives<sup>*required</sup>|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>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
-|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
+|tokenPosition|<a href="#tokenposition">TokenPosition</a>|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. |
 
 ### DQLContainerNode
 
@@ -814,11 +829,11 @@ The DQL node that contains other nodes.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|children|Array&lt;<a href="#dqlnode">DQLNode</a>&gt;|The list of children nodes. |
+|children<sup>*required</sup>|Array&lt;<a href="#dqlnode" target="_blank" rel="noopener noreferrer">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>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
-|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
-|type|"QUERY" &#124; "EXECUTION_BLOCK" &#124; "COMMAND" &#124; "COMMAND_SEPARATOR" &#124; "PARAMETER_WITH_KEY" &#124; "GROUP" &#124; "PARAMETERS" &#124; "PARAMETER_NAMING" &#124; "PARAMETER_ASSIGNMENT" &#124; "PARAMETER_SEPARATOR" &#124; "FUNCTION" &#124; "FUNCTION_PART" &#124; "EXPRESSION" &#124; "IDENTIFIER" &#124; "SOURCE_ID" &#124; "DURATION" &#124; "TIMESTAMP" &#124; "TIMEFRAME" &#124; "TRAVERSAL_PATH" &#124; "TRAVERSAL_STEP"|The type of the node. |
+|tokenPosition|<a href="#tokenposition">TokenPosition</a>|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. |
+|type<sup>*required</sup>|"QUERY" &#124; "EXECUTION_BLOCK" &#124; "COMMAND" &#124; "COMMAND_SEPARATOR" &#124; "PARAMETER_WITH_KEY" &#124; "GROUP" &#124; "PARAMETERS" &#124; "PARAMETER_NAMING" &#124; "PARAMETER_ASSIGNMENT" &#124; "PARAMETER_SEPARATOR" &#124; "FUNCTION" &#124; "FUNCTION_PART" &#124; "EXPRESSION" &#124; "IDENTIFIER" &#124; "SOURCE_ID" &#124; "DURATION" &#124; "TIMESTAMP" &#124; "TIMEFRAME" &#124; "TRAVERSAL_PATH" &#124; "TRAVERSAL_STEP"|The type of the node. |
 
 ### DQLNode
 
@@ -828,7 +843,7 @@ General Node in the DQL query.
 | --- | --- | --- |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
 |nodeType<sup>*required</sup>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
-|tokenPosition|<a href="#tokenposition">TokenPosition</a>|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. |
+|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
 
 ### DQLTerminalNode
 
@@ -836,12 +851,12 @@ Node that represents single token.
 
 | 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' |
+|canonicalString<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Canonical form. |
+|isMandatoryOnUserOrder<sup>*required</sup>|[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>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
-|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
-|type|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "TABULAR_FILE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE" &#124; "ENUM_STRING" &#124; "FIELD_PREFIX" &#124; "BUCKET" &#124; "SMARTSCAPE_NODE_PATTERN" &#124; "SMARTSCAPE_EDGE_PATTERN" &#124; "SMARTSCAPE_NODE_TYPE" &#124; "SMARTSCAPE_EDGE_TYPE"|The type of the autocomplete token. |
+|tokenPosition|<a href="#tokenposition">TokenPosition</a>|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. |
+|type<sup>*required</sup>|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "TABULAR_FILE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE" &#124; "ENUM_STRING" &#124; "FIELD_PREFIX" &#124; "BUCKET" &#124; "SMARTSCAPE_NODE_PATTERN" &#124; "SMARTSCAPE_EDGE_PATTERN" &#124; "SMARTSCAPE_NODE_TYPE" &#124; "SMARTSCAPE_EDGE_TYPE" &#124; "JSON_PATH" &#124; "URL"|The type of the autocomplete token. |
 
 ### ErrorEnvelope
 
@@ -849,7 +864,7 @@ An &apos;envelope&apos; error object that has the mandatory error object.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|error<sup>*required</sup>|<a href="#errorresponse">ErrorResponse</a>|The response for error state |
+|error<sup>*required</sup>|<a href="#errorresponse" target="_blank" rel="noopener noreferrer">ErrorResponse</a>|The response for error state |
 
 ### ErrorResponse
 
@@ -858,7 +873,7 @@ The response for error state
 | 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|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>|Detailed information about the error. |
+|details|<a href="#errorresponsedetails">ErrorResponseDetails</a>|Detailed information about the error. |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
 |retryAfterSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of seconds to wait until the next retry. |
 
@@ -869,7 +884,7 @@ Detailed information about the error.
 | Name | Type | Description |
 | --- | --- | --- |
 |arguments|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The arguments for the message format. |
-|constraintViolations|Array&lt;<a href="#errorresponsedetailsconstraintviolationsitem">ErrorResponseDetailsConstraintViolationsItem</a>&gt;|Information about an input parameter that violated some validation rule of the service API. |
+|constraintViolations|Array&lt;<a href="#errorresponsedetailsconstraintviolationsitem" target="_blank" rel="noopener noreferrer">ErrorResponseDetailsConstraintViolationsItem</a>&gt;|Information about an input parameter that violated some validation rule of the service API. |
 |errorMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Complete error message. |
 |errorMessageFormat|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the error message, string.format based. |
 |errorMessageFormatSpecifierTypes|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. |
@@ -879,7 +894,7 @@ Detailed information about the error.
 |missingScopes|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|List of missing IAM scopes necessary to successfully execute the request. |
 |queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
 |queryString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Submitted query string. |
-|syntaxErrorPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
+|syntaxErrorPosition|<a href="#tokenposition">TokenPosition</a>|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. |
 
 ### ErrorResponseDetailsConstraintViolationsItem
 
@@ -893,20 +908,21 @@ Detailed information about the error.
 
 | 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. |
+|defaultSamplingRatio|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Default sampling ratio. By default no sampling is applied. No upper limit but will be normalized to a power of 10 less than or equal to 100000. |
+|defaultScanLimitGbytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Default scan limit. Can be overridden in DQL. Default value is configured on application level (see documentation of FETCH command). No upper limit. Use -1 for no limit. |
 |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. |
+|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. <i>default:</i> <code>false</code>|
 |enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean to indicate if the query consumption limit should be enforced |
-|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. |
-|filterSegments|<a href="#filtersegments">FilterSegments</a>|Represents a collection of filter segments. |
+|fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time limit for fetching data. It is a  soft limit as further data processing can happen. This limit is configurable and subject to default (typically 300s) and maximum (typically 900s) values defined in the query engine. If the specified value exceeds the maximum allowed value, it will be automatically reduced to the maximum. |
+|filterSegments|<a href="#filtersegments" target="_blank" rel="noopener noreferrer">FilterSegments</a>|Represents a collection of filter segments. |
+|includeContributions|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates whether bucket contribution information should be included in the query response metadata. When set to true, the response will contain details about how each bucket contributed to the query result. <i>default:</i> <code>false</code>|
 |includeTypes|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Parameter to exclude the type information from the query result. In case not specified, the type information will be included. <i>default:</i> <code>true</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'. |
-|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. |
+|maxResultBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of serialized result bytes. Applies to records only and is a soft limit, i.e. the last record that exceeds the limit will be included in the response completely. No upper limit, no default value. |
+|maxResultRecords|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of returned query result records. No upper limit. <i>default:</i> <code>1000</code>|
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
+|queryOptions|<a href="#queryoptions">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
 |requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time the response will be delayed to wait for a result. (This excludes the sending time and time spent in any services between the query-frontend and the client.) If 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' |
 
@@ -917,7 +933,7 @@ The possible type of a field in DQL.
 | Name | Type |
 | --- | --- |
 |type<sup>*required</sup>|"string" &#124; "boolean" &#124; "undefined" &#124; "binary" &#124; "double" &#124; "long" &#124; "timestamp" &#124; "timeframe" &#124; "duration" &#124; "ip_address" &#124; "geo_point" &#124; "array" &#124; "record" &#124; "uid" &#124; "smartscape_id"| 
-|types|Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;|
+|types|Array&lt;<a href="#rangedfieldtypes" target="_blank" rel="noopener noreferrer">RangedFieldTypes</a>&gt;|
 
 ### FilterSegment
 
@@ -926,7 +942,7 @@ A filter segment is identified by an ID. Each segment includes a list of variabl
 | Name | Type |
 | --- | --- |
 |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| 
-|variables|Array&lt;<a href="#filtersegmentvariabledefinition" target="_blank" rel="noopener noreferrer">FilterSegmentVariableDefinition</a>&gt;|
+|variables|Array&lt;<a href="#filtersegmentvariabledefinition">FilterSegmentVariableDefinition</a>&gt;|
 
 ### FilterSegmentVariableDefinition
 
@@ -941,7 +957,7 @@ Defines a variable with a name and a list of values.
 
 Represents a collection of filter segments.
 
-**type**: Array&lt;<a href="#filtersegment">FilterSegment</a>&gt;
+**type**: Array&lt;<a href="#filtersegment" target="_blank" rel="noopener noreferrer">FilterSegment</a>&gt;
 
 ### GeoPoint
 
@@ -958,8 +974,9 @@ Collects various bits of metadata information.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|analysisTimeframe|<a href="#timeframe" target="_blank" rel="noopener noreferrer">Timeframe</a>|DQL data type timeframe. |
+|analysisTimeframe|<a href="#timeframe">Timeframe</a>|DQL data type timeframe. |
 |canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The canonical form of the query. It has normalized spaces and canonical constructs. |
+|contributions|<a href="#contributions" target="_blank" rel="noopener noreferrer">Contributions</a>| |
 |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. |
@@ -1034,7 +1051,7 @@ The exact position in the query string.
 
 Query options enhance query functionality for Dynatrace internal services.
 
-**type**: Record&lt;string, string | undefined&gt;
+**type**: Record&lt;string, string&gt;
 
 ### QueryPollResponse
 
@@ -1082,13 +1099,13 @@ The field type in range.
 
 The mapping between the field name and data type.
 
-**type**: Record&lt;string, FieldType | undefined&gt;
+**type**: Record&lt;string, FieldType&gt;
 
 ### ResultRecord
 
 Single record that contains the result fields.
 
-**type**: Record&lt;string, ResultRecordValue | null | undefined&gt;
+**type**: Record&lt;string, ResultRecordValue | null&gt;
 
 ### Timeframe
 
@@ -1128,6 +1145,12 @@ Verify response.
 |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. |
 
+### ResultRecordValue
+
+Single result field of a record.
+
+**type**: [boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number) | [string](https://developer.mozilla.org/en-US/docs/Glossary/String) | &lt;a href=&quot;#timeframe&quot; target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;&gt;Timeframe&lt;/a&gt; | &lt;a href=&quot;#geopoint&quot;&gt;GeoPoint&lt;/a&gt; | &lt;a href=&quot;#resultrecord&quot; target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;&gt;ResultRecord&lt;/a&gt; | null | Array&lt;ResultRecordValue &amp;#124; null&gt; | null
+
 ## Enums
 
 <a name="dqlnodenodetype"></a>
@@ -1207,7 +1230,7 @@ The type of the autocomplete token.
 
 <div class="padding-left--md">
 
-`Assignment` | `BooleanFalse` | `BooleanTrue` | `BraceClose` | `BraceOpen` | `BracketClose` | `BracketOpen` | `Bucket` | `Colon` | `Comma` | `CommandName` | `DataObject` | `Dot` | `EndComment` | `EntityAttribute` | `EntitySelectorPart` | `EntityType` | `EnumString` | `FieldModifier` | `FieldPattern` | `FieldPrefix` | `FunctionName` | `Indent` | `Linebreak` | `MetricKey` | `Null` | `Number` | `Operator` | `ParameterKey` | `ParameterModifier` | `ParameterValueScope` | `ParenthesisClose` | `ParenthesisOpen` | `ParsePattern` | `Pipe` | `Quote` | `SavedTableName` | `SearchOperator` | `SearchPattern` | `SimpleIdentifier` | `SingleQuote` | `Slash` | `SmartscapeEdgePattern` | `SmartscapeEdgeType` | `SmartscapeIdValue` | `SmartscapeNodePattern` | `SmartscapeNodeType` | `Space` | `String` | `TabularFileName` | `TimeUnit` | `TimeseriesAggregation` | `TimeseriesAggregationExpression` | `TimestampValue` | `TraversalHopCount` | `TraversalOperator` | `TraversalRelationName` | `UidValue` | `Variable`
+`Assignment` | `BooleanFalse` | `BooleanTrue` | `BraceClose` | `BraceOpen` | `BracketClose` | `BracketOpen` | `Bucket` | `Colon` | `Comma` | `CommandName` | `DataObject` | `Dot` | `EndComment` | `EntityAttribute` | `EntitySelectorPart` | `EntityType` | `EnumString` | `FieldModifier` | `FieldPattern` | `FieldPrefix` | `FunctionName` | `Indent` | `JsonPath` | `Linebreak` | `MetricKey` | `Null` | `Number` | `Operator` | `ParameterKey` | `ParameterModifier` | `ParameterValueScope` | `ParenthesisClose` | `ParenthesisOpen` | `ParsePattern` | `Pipe` | `Quote` | `SavedTableName` | `SearchOperator` | `SearchPattern` | `SimpleIdentifier` | `SingleQuote` | `Slash` | `SmartscapeEdgePattern` | `SmartscapeEdgeType` | `SmartscapeIdValue` | `SmartscapeNodePattern` | `SmartscapeNodeType` | `Space` | `String` | `TabularFileName` | `TimeUnit` | `TimeseriesAggregation` | `TimeseriesAggregationExpression` | `TimestampValue` | `TraversalHopCount` | `TraversalOperator` | `TraversalRelationName` | `UidValue` | `Url` | `Variable`
 
 </div>