arrow-left Back to announcements
DATE:
AUTHOR:
Dimensions product team
Dimensions API

Analytics API version 2.0 is available

DATE:
AUTHOR: Dimensions product team

The Dimensions Analytics API Version 2 has been released. 

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. 

What's new in version 2

As previously announced, this release may be backwards incompatible for some users, i.e. those who still rely on deprecated old fields. Therefore, please review your API integrations in order to upgrade and benefit from the latest API features. 

Main takeaways 

  • Version 2 of the Dimensions Analytics API is now available at /api/dsl/v2 (see: API Endpoints)

  • All users are advised to upgrade to version 2 as soon as possible, so to be ready when the version 1 will be sunset in early 2022 (see: Upgrading from V1 to V2)

  • Both versions of the API will be available during this transition period 

  • Version 2 removes all deprecated features and hence it is not backwards-compatible for those users who still rely on those features. 

Timeline 

  • Oct 2021: API V2 is released. V1 enters maintenance mode.

  • Dec 2021: Dimcli, Gsheets plugin & APILab will use API V2 by default 

  • Mar 2022: API V1 is retired 

 Actions required now

We recommend upgrading to Version 2 as quickly as possible to benefit from the new features and avoid last-minute issues in changeover. 

New features in this release

  • Optional return syntax
    The return <source> syntax is now optional, making it quicker to write queries (see the search source page)

  • Searching Acknowledgements
    We added a new search field in publications, which permits to run full-text searches within the acknowledgements section of publications. 

  • Triple quotes syntax
    Full text search queries that include quoted text (e.g. for exact phrase matching) don’t require escaping the inner quotation marks anymore. Simply wrap your query with triple quotes and the DSL will handle the rest. 

Powered by LaunchNotes