Skip to main content

Grail DQL query API changelog

  • Changelog

@dynatrace-sdk/client-query

1.28.0 Released Aug 26, 2026​

Enriched autocomplete suggestion parts

The AutocompleteSuggestionPart model has been extended with additional fields that provide richer context for query autocompletion:

  • category — field category of the suggestion
  • currentParameterKey — current parameter key context
  • dataType — data type associated with the suggestion
  • fieldReference — reference to the associated field
  • priority — ranking priority (higher values rank first)
  • reference — generic reference string
  • referenceType — token type of the reference (TokenType)
  • synopsis — synopsis of the suggestion

These fields are all optional additions to the existing suggestion (required) and type/info fields.

1.27.0 Released Jul 21, 2026​

Minor changes​

  • Add PayloadTooLarge (HTTP 413) error response to /query:execute, /query:verify, /query:parse and /query:autocomplete endpoints, returned when the request body exceeds the maximum allowed size
  • Add new token types to the DQLTerminalNode type field
  • Normalize request header names to lower case

1.26.0 Released May 26, 2026​

Minor changes​

  • Added flags field in response to indicate specific properties of the query execution, such as CLASSIC_ENTITY_MIGRATION_ADVISED.

1.25.0 Released Apr 15, 2026​

Minor changes​

  • Add new body parameter pollingPromiseSeconds to indicate the number of seconds the client promises to send the next polling request after a response for a running query was sent. If the client does not poll within this time window, the query will be cancelled.

1.24.0 Released Mar 17, 2026​

Minor changes​

  • Remove the deprecated enforce-query-consumption-limit header
  • Extend Query API spec descriptions for maxResultBytes, maxResultRecords, defaultScanLimitGbytes and fetchTimeoutSeconds body parameters

1.23.1 Released Mar 13, 2026​

Patch changes​

  • Revert: Fix redundant undefined or optional properties in model types. (APPDEV-7583) (APPDEV-16631)

1.23.0 Released Feb 27, 2026​

Minor changes

Minor changes​

  • Adds the additional response body parameter "aggregation" to the metadata section.

1.22.1 Released Feb 18, 2026​

Patch changes

  • Improve description of query-api spec

1.22.0 Released Jan 22, 2026​

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 Released Dec 9, 2025​

Patch changes​

  • Replace HTML tags with Markdown
  • Improve some descriptions for query-api spec

1.21.2 Released Sep 5, 2025​

Patch changes​

  • Fix transformations for date format strings. (APPDEV-14400)
  • Update dependencies. (APPDEV-14014)
  • Update dependencies. (APPDEV-13611)

1.21.1 Released Jun 11, 2025​

Patch changes​

  • Update dependencies. (APPDEV-11813)

1.21.0 Released Jun 2, 2025​

Minor changes​

  • Add new token types to the TokenType enum
  • Add Retry-After header that indicates the number of seconds to wait before retrying the request
  • Add retryAfterSeconds property to ErrorResponse to indicate the number of seconds to wait until the next retry
  • Deprecate enfore-query-consumption-limit header
  • Add enforceQueryConsumptionLimit body parameter to ExecuteRequest and AutocompleteRequest

1.20.2 Released May 16, 2025​

Patch changes​

  • Improve performance of date transformations. (APPDEV-12840)

1.20.1 Released May 9, 2025​

Patch changes​

  • Improve performance of payload transformations. (APPDEV-12840)
  • Remove generatedAt property from metadata file. (APPDEV-12696)

1.20.0 Released Mar 31, 2025​

Minor changes​

  • Add request body parameter includeTypes to ExecuteRequest
  • Add header dt-client-context to all query endpoints
  • Add enforce-query-consumption-limit header to /query:execute and /query:autocomplete endpoints

1.19.0 Released Mar 12, 2025​

Minor changes​

  • Added support for optional transformations. (APPDEV-11914)

Patch changes​

  • Added fix for 'transformToFormDataField' function. (APPDEV-12478)

1.18.1 Released Jan 10, 2025​

Patch changes​

  • Fix date-time format serialization. (APPDEV-11661)

1.18.0 Released Dec 12, 2024​

Minor changes​

  • Add scalar parameter to MetricMetadata
  • Add SEARCH_OPERATOR, SEARCH_PATTERN, SAVED_TABLE_NAME and PARAMETER_MODIFIER to the TokenType enum

1.17.1 Released Dec 12, 2024​

Patch changes​

  • Replace model transformations with single transformation function. (APPDEV-10818)
  • Redundant error serializers are removed. (APPDEV-10272)
  • Missing await added for API Gateway handler and line breaks at the end of the string are ignored. APPDEV-10883
  • Imports reformatted and fixed incorrect type rendered for arrays of enum values. APPDEV-10701

1.17.0 Released Oct 8, 2024​

Minor changes​

  • Enums are replaced with unions of literals. APPDEV-10338
  • Inline enums as union of literals. APPDEV-9924

Patch changes​

  • Add return types and improve usage examples inside JSDoc. APPDEV-7536

1.16.0 Released Aug 28, 2024​

Features​

  • Export errors from the package.

1.15.0 Released Aug 6, 2024​

Minor changes​

  • Add new token type to the TokenType enum and new field type to the FieldType enum.

1.14.0 Released Jul 31, 2024​

Minor changes​

  • Introduced @dynatrace-sdk/shared-errors package and improved response errors handling.

1.13.0 Released Jul 18, 2024​

Features​

  • Add filterSegments property to ExecuteRequest

1.12.1 Released Jun 10, 2024​

Patch changes​

  • Updated boolean serialization handling. APPDEV-9047

1.12.0 Released Jun 5, 2024​

Minor changes​

  • Client updated to support latest API changes. NOISSUE
  • Updated dependencies
    • @dynatrace-sdk/http-client@1.3.0

Patch changes​

  • Documentation removed from the package. APPDEV-8356

1.11.1 Released May 17, 2024​

Patch changes​

  • Fix broken links in the readme file.

1.11.0 Released Apr 17, 2024​

Minor changes​

  • Add canonicalQuery property to VerifyRequest
  • Provide actual error code in the error message instead of wildcard. APPDEV-7744
  • Add option to generate canonical query to VerifyRequest

Patch changes​

  • Do not print empty fields in the default message of an error. APPDEV-7630
  • Fix typo in the description of defaultTimeframeStart
  • Remove Authorization header
  • Update documentation. APPDEV-8154

1.10.1 Released Mar 29, 2024​

Patch changes​

  • Fixed explode method of query parameters serialization.
  • Sanitize links in the documentation
  • Add API reference to the readme file

1.10.0 Released Mar 5, 2024​

Minor changes​

  • Add QueryOptions to AutocompleteRequest, ExecuteRequest and ParseRequest
  • Add shifted parameter to MetricMetadata
  • Add new token types to the TokenType enum

Patch changes​

  • Update http-client

1.9.1 Released Feb 6, 2024​

Patch changes​

  • Update documentation

1.9.0 Released Feb 1, 2024​

Minor changes​

  • queryId was added to ErrorResponseDetails
  • scannedDataPoints was added to GrailMetadata (datapoints that have been scanned during a timeseries query)
  • maxDataSuggestions was added to AutocompleteRequest (max number of dynamic entries that should be returned e.g. metric keys, metric dimensions and custom fields)

1.8.1 Released Jan 12, 2024​

Patch changes​

  • Update documentation.

1.8.0 Released Dec 28, 2023​

Minor changes​

  • rollup and rate properties were added to the MetricMetadata object

1.7.2 Released Nov 10, 2023​

Patch changes​

  • Fixed a bug that caused abort errors from http-client to be wrapped in ApiClientError('UnexpectedError').

1.7.1 Released Nov 8, 2023​

Patch changes​

  • Update dependencies.

1.7.0 Released Nov 2, 2023​

Minor changes​

  • Handle 429 error code in query execution.
  • Add UID_VALUE Autocomplete Token Type.
  • Handle generic 4XX and 5XX error codes in query execution.

Patch changes​

  • Fixed a bug that caused internal http-client errors to be thrown for error responses.

1.6.0 Released Oct 24, 2023​

Minor changes​

  • New response FieldType enum value: uid
  • Add enrich query param to the query cancel method

1.5.1 Released Oct 3, 2023​

Patch changes​

  • Update JSDoc examples.

1.5.0 Released Sep 21, 2023​

Minor changes​

  • Change title from Storage – Query Service to DQL Query
  • Support 400 error code for poll and cancel operations.

1.4.3 Released Aug 7, 2023​

Patch changes​

  • Fix transformation of null values for nullable properties

1.4.2 Released Jul 28, 2023​

Patch changes​

  • Update documentation

  • Fix transformation of null and Date values

  • Update package description

  • Updated dependencies

    • @dynatrace-sdk/http-client@1.0.6

1.4.1 Released Jul 13, 2023​

Patch changes​

  • Update error messages

  • Updated dependencies

    • @dynatrace-sdk/http-client@1.0.5

1.4.0 Released Jun 29, 2023​

Minor changes​

  • Add max-result-bytes query parameter to DPS Query API

1.3.1 Released Jun 27, 2023​

Patch changes​

  • Update documentation

1.3.0 Released Jun 15, 2023​

Minor changes​

  • Expose the metric metadata fieldName.

1.2.2 Released Jun 7, 2023​

Patch changes​

  • Update docs.

1.2.1 Released Jun 6, 2023​

Patch changes​

  • Add JSDoc @example for operations.
  • Fix handling of the application/cloudevent+json content type.

1.2.0 Released May 4, 2023​

Minor changes​

  • Add sampled property to GrailMetadata

1.1.0 Released Apr 19, 2023​

Minor changes​

  • Export model transformations

1.0.6 Released Apr 19, 2023​

Patch changes​

  • Move model transformations to a separate module
  • Update @dynatrace-sdk/http-client to ^1.0.3

1.0.5 Released Apr 5, 2023​

Patch changes​

  • Update @dynatrace-sdk/http-client to ^1.0.1
  • Use parsed response body in error serializer

1.0.4 Released Apr 3, 2023​

Patch changes​

  • Send response body in error serializer
  • Updated dependencies
    • @dynatrace-sdk/http-client@1.0.0

1.0.3 Released Mar 23, 2023​

Patch changes​

  • Updated descriptions and examples.

1.0.2 Released Mar 23, 2023​

Patch changes​

  • Generate client package with template-typescript-client v0.13.10. Query question mark is now removed from url when there are no search params.

1.0.1 Released Mar 16, 2023​

Patch changes​

  • Generate client package with template-typescript-client v0.13.9. Config param is now optional for valid operations. Improve error handling of unsupported data types.
  • Process HTML tags in the documentation.
  • Add missing typeguards and improve data transformations.

1.0.0 Released Mar 10, 2023​

Major changes​

  • Initial release of @dynatrace-sdk/client-query.
Still have questions?
Find answers in the Dynatrace Community