@dynatrace-sdk/client-query 1.21.2 → 1.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/README.md +59 -36
- package/cjs/index.js +191 -188
- package/dynatrace-metadata.json +3 -3
- package/esm/index.js +191 -188
- package/package.json +1 -1
- package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts +48 -48
- package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts +23 -23
- package/types/packages/client/query/src/lib/models/autocomplete-request.d.ts +12 -6
- package/types/packages/client/query/src/lib/models/autocomplete-response.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/autocomplete-suggestion-part.d.ts +6 -6
- package/types/packages/client/query/src/lib/models/autocomplete-suggestion.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/bucket-contribution.d.ts +6 -0
- package/types/packages/client/query/src/lib/models/contributions.d.ts +4 -0
- package/types/packages/client/query/src/lib/models/dql-alternative-node.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/dql-container-node.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/dql-node.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/dql-terminal-node.d.ts +5 -5
- package/types/packages/client/query/src/lib/models/error-response-details-constraint-violations-item.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/error-response-details.d.ts +21 -21
- package/types/packages/client/query/src/lib/models/error-response.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/execute-request.d.ts +35 -31
- package/types/packages/client/query/src/lib/models/grail-metadata.d.ts +25 -23
- package/types/packages/client/query/src/lib/models/index.d.ts +2 -0
- package/types/packages/client/query/src/lib/models/metadata-notification.d.ts +12 -12
- package/types/packages/client/query/src/lib/models/metric-metadata.d.ts +12 -12
- package/types/packages/client/query/src/lib/models/parse-request.d.ts +8 -8
- package/types/packages/client/query/src/lib/models/query-options.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/query-poll-response.d.ts +8 -8
- package/types/packages/client/query/src/lib/models/query-result.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/query-start-response.d.ts +8 -8
- package/types/packages/client/query/src/lib/models/ranged-field-types-mappings.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/ranged-field-types.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/result-record.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/timeframe.d.ts +4 -4
- package/types/packages/client/query/src/lib/models/token-position.d.ts +2 -2
- package/types/packages/client/query/src/lib/models/token-type.d.ts +3 -1
- package/types/packages/client/query/src/lib/models/verify-request.d.ts +9 -9
- package/types/packages/client/query/src/lib/models/verify-response.d.ts +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
@dynatrace-sdk/client-query
|
|
4
4
|
|
|
5
|
+
## 1.22.0
|
|
6
|
+
|
|
7
|
+
### Minor Changes
|
|
8
|
+
- Add new token types to the `TokenType` enum
|
|
9
|
+
- Add new body parameter `includeContributions` to indicate whether contribution information should be included in the query response metadata.
|
|
10
|
+
|
|
11
|
+
## 1.21.3
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Replace HTML tags with Markdown
|
|
16
|
+
- Improve some descriptions for query-api spec
|
|
17
|
+
|
|
5
18
|
## 1.21.2
|
|
6
19
|
|
|
7
20
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-query
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.22.0)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
Exposes an API to fetch records stored in Grail
|
|
@@ -315,7 +315,7 @@ can be identified by checking whether `alternatives` is present
|
|
|
315
315
|
|
|
316
316
|
Field | Mandatory | Description
|
|
317
317
|
----------------------- | --- | ----------------------------------------------------------------------------------------
|
|
318
|
-
alternatives | yes | Type: Map&
|
|
318
|
+
alternatives | yes | Type: Map<AlternativeType, DQLNode>
|
|
319
319
|
|
|
320
320
|
When displaying the query, pick one option. You may use the other options for hovering, replacing, and more.
|
|
321
321
|
|
|
@@ -713,7 +713,7 @@ It is guaranteed that every field of every record will have a corresponding type
|
|
|
713
713
|
| --- | --- | --- |
|
|
714
714
|
|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. |
|
|
715
715
|
|config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
|
|
716
|
-
|config.requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
716
|
+
|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). |
|
|
717
717
|
|config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
|
|
718
718
|
|
|
719
719
|
|
|
@@ -758,10 +758,10 @@ const data = await queryExecutionClient.queryPoll({
|
|
|
758
758
|
|
|
759
759
|
| Name | Type | Description |
|
|
760
760
|
| --- | --- | --- |
|
|
761
|
-
|cursorPosition|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
761
|
+
|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. |
|
|
762
762
|
|enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean to indicate if the query consumption limit should be enforced |
|
|
763
763
|
|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'. |
|
|
764
|
-
|maxDataSuggestions|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
764
|
+
|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. |
|
|
765
765
|
|query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
|
|
766
766
|
|queryOptions|<a href="#queryoptions">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
|
|
767
767
|
|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.
|
|
|
795
795
|
|info|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the suggestion. |
|
|
796
796
|
|suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
|
|
797
797
|
|synopsis|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The synopsis of the suggestion. |
|
|
798
|
-
|type<sup>*required</sup>|"SPACE" | "LINEBREAK" | "INDENT" | "PIPE" | "DOT" | "COLON" | "COMMA" | "ASSIGNMENT" | "BRACE_OPEN" | "BRACE_CLOSE" | "BRACKET_OPEN" | "BRACKET_CLOSE" | "PARENTHESIS_OPEN" | "PARENTHESIS_CLOSE" | "QUOTE" | "SINGLE_QUOTE" | "SLASH" | "BOOLEAN_TRUE" | "BOOLEAN_FALSE" | "NULL" | "COMMAND_NAME" | "PARAMETER_KEY" | "PARAMETER_VALUE_SCOPE" | "FUNCTION_NAME" | "TIMESERIES_AGGREGATION" | "TIMESERIES_AGGREGATION_EXPRESSION" | "OPERATOR" | "SEARCH_OPERATOR" | "TRAVERSAL_OPERATOR" | "TRAVERSAL_RELATION_NAME" | "TRAVERSAL_HOP_COUNT" | "SIMPLE_IDENTIFIER" | "DATA_OBJECT" | "NUMBER" | "STRING" | "TIME_UNIT" | "TIMESTAMP_VALUE" | "METRIC_KEY" | "VARIABLE" | "END_COMMENT" | "UID_VALUE" | "PARSE_PATTERN" | "FIELD_PATTERN" | "SEARCH_PATTERN" | "ENTITY_SELECTOR_PART" | "SAVED_TABLE_NAME" | "TABULAR_FILE_NAME" | "PARAMETER_MODIFIER" | "FIELD_MODIFIER" | "ENTITY_TYPE" | "ENTITY_ATTRIBUTE" | "SMARTSCAPE_ID_VALUE" | "ENUM_STRING" | "FIELD_PREFIX" | "BUCKET" | "SMARTSCAPE_NODE_PATTERN" | "SMARTSCAPE_EDGE_PATTERN" | "SMARTSCAPE_NODE_TYPE" | "SMARTSCAPE_EDGE_TYPE"|The type of the autocomplete token. |
|
|
798
|
+
|type<sup>*required</sup>|"SPACE" | "LINEBREAK" | "INDENT" | "PIPE" | "DOT" | "COLON" | "COMMA" | "ASSIGNMENT" | "BRACE_OPEN" | "BRACE_CLOSE" | "BRACKET_OPEN" | "BRACKET_CLOSE" | "PARENTHESIS_OPEN" | "PARENTHESIS_CLOSE" | "QUOTE" | "SINGLE_QUOTE" | "SLASH" | "BOOLEAN_TRUE" | "BOOLEAN_FALSE" | "NULL" | "COMMAND_NAME" | "PARAMETER_KEY" | "PARAMETER_VALUE_SCOPE" | "FUNCTION_NAME" | "TIMESERIES_AGGREGATION" | "TIMESERIES_AGGREGATION_EXPRESSION" | "OPERATOR" | "SEARCH_OPERATOR" | "TRAVERSAL_OPERATOR" | "TRAVERSAL_RELATION_NAME" | "TRAVERSAL_HOP_COUNT" | "SIMPLE_IDENTIFIER" | "DATA_OBJECT" | "NUMBER" | "STRING" | "TIME_UNIT" | "TIMESTAMP_VALUE" | "METRIC_KEY" | "VARIABLE" | "END_COMMENT" | "UID_VALUE" | "PARSE_PATTERN" | "FIELD_PATTERN" | "SEARCH_PATTERN" | "ENTITY_SELECTOR_PART" | "SAVED_TABLE_NAME" | "TABULAR_FILE_NAME" | "PARAMETER_MODIFIER" | "FIELD_MODIFIER" | "ENTITY_TYPE" | "ENTITY_ATTRIBUTE" | "SMARTSCAPE_ID_VALUE" | "ENUM_STRING" | "FIELD_PREFIX" | "BUCKET" | "SMARTSCAPE_NODE_PATTERN" | "SMARTSCAPE_EDGE_PATTERN" | "SMARTSCAPE_NODE_TYPE" | "SMARTSCAPE_EDGE_TYPE" | "JSON_PATH" | "URL"|The type of the autocomplete token. |
|
|
799
|
+
|
|
800
|
+
### BucketContribution
|
|
801
|
+
|
|
802
|
+
| Name | Type |
|
|
803
|
+
| --- | --- |
|
|
804
|
+
|matchedRecordsRatio|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
805
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
806
|
+
|scannedBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
807
|
+
|table|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
808
|
+
|
|
809
|
+
### Contributions
|
|
810
|
+
|
|
811
|
+
| Name | Type |
|
|
812
|
+
| --- | --- |
|
|
813
|
+
|buckets|Array<<a href="#bucketcontribution" target="_blank" rel="noopener noreferrer">BucketContribution</a>>|
|
|
799
814
|
|
|
800
815
|
### DQLAlternativeNode
|
|
801
816
|
|
|
@@ -803,10 +818,10 @@ The DQL node that has alternatives.
|
|
|
803
818
|
|
|
804
819
|
| Name | Type | Description |
|
|
805
820
|
| --- | --- | --- |
|
|
806
|
-
|alternatives
|
|
821
|
+
|alternatives<sup>*required</sup>|object|The different alternatives. |
|
|
807
822
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
808
823
|
|nodeType<sup>*required</sup>|"TERMINAL" | "CONTAINER" | "ALTERNATIVE"|The type of the node. |
|
|
809
|
-
|tokenPosition|<a href="#tokenposition"
|
|
824
|
+
|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. |
|
|
810
825
|
|
|
811
826
|
### DQLContainerNode
|
|
812
827
|
|
|
@@ -814,11 +829,11 @@ The DQL node that contains other nodes.
|
|
|
814
829
|
|
|
815
830
|
| Name | Type | Description |
|
|
816
831
|
| --- | --- | --- |
|
|
817
|
-
|children
|
|
832
|
+
|children<sup>*required</sup>|Array<<a href="#dqlnode" target="_blank" rel="noopener noreferrer">DQLNode</a>>|The list of children nodes. |
|
|
818
833
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
819
834
|
|nodeType<sup>*required</sup>|"TERMINAL" | "CONTAINER" | "ALTERNATIVE"|The type of the node. |
|
|
820
|
-
|tokenPosition|<a href="#tokenposition"
|
|
821
|
-
|type
|
|
835
|
+
|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. |
|
|
836
|
+
|type<sup>*required</sup>|"QUERY" | "EXECUTION_BLOCK" | "COMMAND" | "COMMAND_SEPARATOR" | "PARAMETER_WITH_KEY" | "GROUP" | "PARAMETERS" | "PARAMETER_NAMING" | "PARAMETER_ASSIGNMENT" | "PARAMETER_SEPARATOR" | "FUNCTION" | "FUNCTION_PART" | "EXPRESSION" | "IDENTIFIER" | "SOURCE_ID" | "DURATION" | "TIMESTAMP" | "TIMEFRAME" | "TRAVERSAL_PATH" | "TRAVERSAL_STEP"|The type of the node. |
|
|
822
837
|
|
|
823
838
|
### DQLNode
|
|
824
839
|
|
|
@@ -828,7 +843,7 @@ General Node in the DQL query.
|
|
|
828
843
|
| --- | --- | --- |
|
|
829
844
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
830
845
|
|nodeType<sup>*required</sup>|"TERMINAL" | "CONTAINER" | "ALTERNATIVE"|The type of the node. |
|
|
831
|
-
|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. |
|
|
846
|
+
|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. |
|
|
832
847
|
|
|
833
848
|
### DQLTerminalNode
|
|
834
849
|
|
|
@@ -836,12 +851,12 @@ Node that represents single token.
|
|
|
836
851
|
|
|
837
852
|
| Name | Type | Description |
|
|
838
853
|
| --- | --- | --- |
|
|
839
|
-
|canonicalString
|
|
840
|
-
|isMandatoryOnUserOrder
|
|
854
|
+
|canonicalString<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Canonical form. |
|
|
855
|
+
|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' |
|
|
841
856
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
842
857
|
|nodeType<sup>*required</sup>|"TERMINAL" | "CONTAINER" | "ALTERNATIVE"|The type of the node. |
|
|
843
|
-
|tokenPosition|<a href="#tokenposition"
|
|
844
|
-
|type
|
|
858
|
+
|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. |
|
|
859
|
+
|type<sup>*required</sup>|"SPACE" | "LINEBREAK" | "INDENT" | "PIPE" | "DOT" | "COLON" | "COMMA" | "ASSIGNMENT" | "BRACE_OPEN" | "BRACE_CLOSE" | "BRACKET_OPEN" | "BRACKET_CLOSE" | "PARENTHESIS_OPEN" | "PARENTHESIS_CLOSE" | "QUOTE" | "SINGLE_QUOTE" | "SLASH" | "BOOLEAN_TRUE" | "BOOLEAN_FALSE" | "NULL" | "COMMAND_NAME" | "PARAMETER_KEY" | "PARAMETER_VALUE_SCOPE" | "FUNCTION_NAME" | "TIMESERIES_AGGREGATION" | "TIMESERIES_AGGREGATION_EXPRESSION" | "OPERATOR" | "SEARCH_OPERATOR" | "TRAVERSAL_OPERATOR" | "TRAVERSAL_RELATION_NAME" | "TRAVERSAL_HOP_COUNT" | "SIMPLE_IDENTIFIER" | "DATA_OBJECT" | "NUMBER" | "STRING" | "TIME_UNIT" | "TIMESTAMP_VALUE" | "METRIC_KEY" | "VARIABLE" | "END_COMMENT" | "UID_VALUE" | "PARSE_PATTERN" | "FIELD_PATTERN" | "SEARCH_PATTERN" | "ENTITY_SELECTOR_PART" | "SAVED_TABLE_NAME" | "TABULAR_FILE_NAME" | "PARAMETER_MODIFIER" | "FIELD_MODIFIER" | "ENTITY_TYPE" | "ENTITY_ATTRIBUTE" | "SMARTSCAPE_ID_VALUE" | "ENUM_STRING" | "FIELD_PREFIX" | "BUCKET" | "SMARTSCAPE_NODE_PATTERN" | "SMARTSCAPE_EDGE_PATTERN" | "SMARTSCAPE_NODE_TYPE" | "SMARTSCAPE_EDGE_TYPE" | "JSON_PATH" | "URL"|The type of the autocomplete token. |
|
|
845
860
|
|
|
846
861
|
### ErrorEnvelope
|
|
847
862
|
|
|
@@ -849,7 +864,7 @@ An 'envelope' error object that has the mandatory error object.
|
|
|
849
864
|
|
|
850
865
|
| Name | Type | Description |
|
|
851
866
|
| --- | --- | --- |
|
|
852
|
-
|error<sup>*required</sup>|<a href="#errorresponse">ErrorResponse</a>|The response for error state |
|
|
867
|
+
|error<sup>*required</sup>|<a href="#errorresponse" target="_blank" rel="noopener noreferrer">ErrorResponse</a>|The response for error state |
|
|
853
868
|
|
|
854
869
|
### ErrorResponse
|
|
855
870
|
|
|
@@ -858,7 +873,7 @@ The response for error state
|
|
|
858
873
|
| Name | Type | Description |
|
|
859
874
|
| --- | --- | --- |
|
|
860
875
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Error code, which normally matches the HTTP error code. |
|
|
861
|
-
|details|<a href="#errorresponsedetails"
|
|
876
|
+
|details|<a href="#errorresponsedetails">ErrorResponseDetails</a>|Detailed information about the error. |
|
|
862
877
|
|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
|
|
863
878
|
|retryAfterSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of seconds to wait until the next retry. |
|
|
864
879
|
|
|
@@ -869,7 +884,7 @@ Detailed information about the error.
|
|
|
869
884
|
| Name | Type | Description |
|
|
870
885
|
| --- | --- | --- |
|
|
871
886
|
|arguments|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The arguments for the message format. |
|
|
872
|
-
|constraintViolations|Array<<a href="#errorresponsedetailsconstraintviolationsitem">ErrorResponseDetailsConstraintViolationsItem</a>>|Information about an input parameter that violated some validation rule of the service API. |
|
|
887
|
+
|constraintViolations|Array<<a href="#errorresponsedetailsconstraintviolationsitem" target="_blank" rel="noopener noreferrer">ErrorResponseDetailsConstraintViolationsItem</a>>|Information about an input parameter that violated some validation rule of the service API. |
|
|
873
888
|
|errorMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Complete error message. |
|
|
874
889
|
|errorMessageFormat|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the error message, string.format based. |
|
|
875
890
|
|errorMessageFormatSpecifierTypes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|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.
|
|
|
879
894
|
|missingScopes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|List of missing IAM scopes necessary to successfully execute the request. |
|
|
880
895
|
|queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
881
896
|
|queryString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Submitted query string. |
|
|
882
|
-
|syntaxErrorPosition|<a href="#tokenposition"
|
|
897
|
+
|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. |
|
|
883
898
|
|
|
884
899
|
### ErrorResponseDetailsConstraintViolationsItem
|
|
885
900
|
|
|
@@ -893,20 +908,21 @@ Detailed information about the error.
|
|
|
893
908
|
|
|
894
909
|
| Name | Type | Description |
|
|
895
910
|
| --- | --- | --- |
|
|
896
|
-
|defaultSamplingRatio|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
897
|
-
|defaultScanLimitGbytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
911
|
+
|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. |
|
|
912
|
+
|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. |
|
|
898
913
|
|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> |
|
|
899
914
|
|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> |
|
|
900
|
-
|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.
|
|
915
|
+
|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>|
|
|
901
916
|
|enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean to indicate if the query consumption limit should be enforced |
|
|
902
|
-
|fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The
|
|
903
|
-
|filterSegments|<a href="#filtersegments">FilterSegments</a>|Represents a collection of filter segments. |
|
|
917
|
+
|fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time limit for fetching data. Soft limit as further data processing can happen. No upper limit in API but application level default and maximum fetch timeout also applies. |
|
|
918
|
+
|filterSegments|<a href="#filtersegments" target="_blank" rel="noopener noreferrer">FilterSegments</a>|Represents a collection of filter segments. |
|
|
919
|
+
|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>|
|
|
904
920
|
|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>|
|
|
905
921
|
|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'. |
|
|
906
|
-
|maxResultBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result bytes that
|
|
907
|
-
|maxResultRecords|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result records
|
|
922
|
+
|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. |
|
|
923
|
+
|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>|
|
|
908
924
|
|query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
|
|
909
|
-
|queryOptions|<a href="#queryoptions"
|
|
925
|
+
|queryOptions|<a href="#queryoptions">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
|
|
910
926
|
|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. |
|
|
911
927
|
|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' |
|
|
912
928
|
|
|
@@ -917,7 +933,7 @@ The possible type of a field in DQL.
|
|
|
917
933
|
| Name | Type |
|
|
918
934
|
| --- | --- |
|
|
919
935
|
|type<sup>*required</sup>|"string" | "boolean" | "undefined" | "binary" | "double" | "long" | "timestamp" | "timeframe" | "duration" | "ip_address" | "geo_point" | "array" | "record" | "uid" | "smartscape_id"|
|
|
920
|
-
|types|Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>>|
|
|
936
|
+
|types|Array<<a href="#rangedfieldtypes" target="_blank" rel="noopener noreferrer">RangedFieldTypes</a>>|
|
|
921
937
|
|
|
922
938
|
### FilterSegment
|
|
923
939
|
|
|
@@ -926,7 +942,7 @@ A filter segment is identified by an ID. Each segment includes a list of variabl
|
|
|
926
942
|
| Name | Type |
|
|
927
943
|
| --- | --- |
|
|
928
944
|
|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
929
|
-
|variables|Array<<a href="#filtersegmentvariabledefinition"
|
|
945
|
+
|variables|Array<<a href="#filtersegmentvariabledefinition">FilterSegmentVariableDefinition</a>>|
|
|
930
946
|
|
|
931
947
|
### FilterSegmentVariableDefinition
|
|
932
948
|
|
|
@@ -941,7 +957,7 @@ Defines a variable with a name and a list of values.
|
|
|
941
957
|
|
|
942
958
|
Represents a collection of filter segments.
|
|
943
959
|
|
|
944
|
-
**type**: Array<<a href="#filtersegment">FilterSegment</a>>
|
|
960
|
+
**type**: Array<<a href="#filtersegment" target="_blank" rel="noopener noreferrer">FilterSegment</a>>
|
|
945
961
|
|
|
946
962
|
### GeoPoint
|
|
947
963
|
|
|
@@ -958,8 +974,9 @@ Collects various bits of metadata information.
|
|
|
958
974
|
|
|
959
975
|
| Name | Type | Description |
|
|
960
976
|
| --- | --- | --- |
|
|
961
|
-
|analysisTimeframe|<a href="#timeframe"
|
|
977
|
+
|analysisTimeframe|<a href="#timeframe">Timeframe</a>|DQL data type timeframe. |
|
|
962
978
|
|canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The canonical form of the query. It has normalized spaces and canonical constructs. |
|
|
979
|
+
|contributions|<a href="#contributions" target="_blank" rel="noopener noreferrer">Contributions</a>| |
|
|
963
980
|
|dqlVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of DQL that was used to process the query request. |
|
|
964
981
|
|executionTimeMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time it took to execute the query. |
|
|
965
982
|
|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.
|
|
|
1034
1051
|
|
|
1035
1052
|
Query options enhance query functionality for Dynatrace internal services.
|
|
1036
1053
|
|
|
1037
|
-
**type**: Record<string, string
|
|
1054
|
+
**type**: Record<string, string>
|
|
1038
1055
|
|
|
1039
1056
|
### QueryPollResponse
|
|
1040
1057
|
|
|
@@ -1082,13 +1099,13 @@ The field type in range.
|
|
|
1082
1099
|
|
|
1083
1100
|
The mapping between the field name and data type.
|
|
1084
1101
|
|
|
1085
|
-
**type**: Record<string, FieldType
|
|
1102
|
+
**type**: Record<string, FieldType>
|
|
1086
1103
|
|
|
1087
1104
|
### ResultRecord
|
|
1088
1105
|
|
|
1089
1106
|
Single record that contains the result fields.
|
|
1090
1107
|
|
|
1091
|
-
**type**: Record<string, ResultRecordValue | null
|
|
1108
|
+
**type**: Record<string, ResultRecordValue | null>
|
|
1092
1109
|
|
|
1093
1110
|
### Timeframe
|
|
1094
1111
|
|
|
@@ -1128,6 +1145,12 @@ Verify response.
|
|
|
1128
1145
|
|notifications|Array<<a href="#metadatanotification">MetadataNotification</a>>|The notifications related to the supplied DQL query string. |
|
|
1129
1146
|
|valid<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the supplied DQL query string is valid. |
|
|
1130
1147
|
|
|
1148
|
+
### ResultRecordValue
|
|
1149
|
+
|
|
1150
|
+
Single result field of a record.
|
|
1151
|
+
|
|
1152
|
+
**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) | <a href="#timeframe" target="_blank" rel="noopener noreferrer">Timeframe</a> | <a href="#geopoint">GeoPoint</a> | <a href="#resultrecord" target="_blank" rel="noopener noreferrer">ResultRecord</a> | null | Array<ResultRecordValue &#124; null> | null
|
|
1153
|
+
|
|
1131
1154
|
## Enums
|
|
1132
1155
|
|
|
1133
1156
|
<a name="dqlnodenodetype"></a>
|
|
@@ -1207,7 +1230,7 @@ The type of the autocomplete token.
|
|
|
1207
1230
|
|
|
1208
1231
|
<div class="padding-left--md">
|
|
1209
1232
|
|
|
1210
|
-
`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`
|
|
1233
|
+
`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`
|
|
1211
1234
|
|
|
1212
1235
|
</div>
|
|
1213
1236
|
|