Release Notes and Deprecations

Versions History

This page contains version history information for the version 2 of the Dimensions Analytics API.

Note

Older release notes are available on the legacy API Version 1 documentation.

Important

The Version 1 of the API is in maintenance mode and will no longer be available from March 2022. See the API endpoints page for more information on how to switch versions.

Verson 2.0.0 — 2021, October, Week of 18th

This release brings about many improvements to the overall stability and performance of the API, but most importantly, it removes all previously deprecated fields. By doing so, it gives us a more solid platform on which to continue innovating by adding new features to the API and the Dimensions Search Language. See also the how to upgrade from V1 to V2 page.

New features:

  1. The return <source> syntax is now optional (see the search source page)

  2. New search field acknowledgements in publications

  3. Triple quotes syntax for full-text search


Deprecations History

This section lists API V2 fields and search fields that have been deprecated and should not be used (for older deprecations, see also the legacy V1 API deprecations page).

Warning

This fields will be supported in versions 2.x and removed in the next major release. To ensure full compatibility with the upcoming major release, it is recommend to stop using deprecated fields as soon as possible.

Deprecated Fields

Partially Deprecated Fields

On the following fields only certain features are deprecated (e.g. filtering or faceting).

Deprecated Search Indexes

Deprecated Functions