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.

Version 2.9.1 — 2024, February, Week of 12th

Fixed issue regarding returning 408 after a short period of time.
Researchers are now by default filtered for obsolete researchers.
Updated version of concepts, RCDC and UoA fields.
Publications are now by default sorted by relevance, instead of date.

Version 2.9.0 — 2024, January, Week of 29th

New field document_type in Publications.
New return functions prettify which provides semicolon separated string for multi value fields.
New field active_status in Grants.

Version 2.8.0 — 2023, September, Week of 25th

Function Searching using abstracts now supported for Grants sources as well.
New search index concepts in the Reports core.
New field kind in Patents core.
New field journal_lists in Source Titles core.
Field category_for_2008 removed from all relevant sources.
Documentation about hyperauthorship truncation of results has been updated, see Dealing with hyper-authorship.
Documentation about which sources support multi-index search has been updated, see Searching in multiple search indexes in a single query.

Version 2.7.0 — 2023, May, Week of 22nd

New search field assignees in Patents.
New fields application_number, family_count and filing_date in Patents.
New search field raw_affiliations in Grants.
New search field raw_affiliations in Clinical Trials.
Field publisher in Source Titles is deprecated, see Deprecations History.

Version 2.6.0 — 2023, February, Week of 13th

New sources Funder Groups and Research Org Groups.
New fields orange_book, federal_support and claims_amount in Patents.
New field country_code in Organizations.
New fields start_date and end_date in Clinical Trials. Field date is now deprecated in favor of start_date.
Field project_number in Grants enabled for filtering.
New documentation section Technical Limits.

Version 2.5.0 — 2022, December, Week of 12th

Sorting by title in all sources is discouraged, as it may not function properly in some cases. It will be completely disallowed in the future.
New field project_numbers in Grants.

Version 2.4.0 — 2022, November, Week of 7th

New field funding_section in Publications.
Field category_for now points to category_for_2020 in all relevant content sources.
New feature Searching using abstracts is available for Publications.
New fields funding_schemes, keywords for Grants.

Version 2.3.0 — 2022, October, Week of 3rd

Field current_organization_id of the authors field in Publications is now deprecated. Please use the current_research_org field in the Researchers source.
New fields category_for_2008 and category_for_2020 in all relevant content sources. category_for field remains an alias for the category_for_2008 in this release. In the next release, approximately 4 weeks from this release, category_for field will point to the category_for_2020 field.

Version 2.2.0 — 2022, August, Week of 1st

Field funding_org_acronym in Grants renamed to funder_org_acronym.
Field funding_org_city in Grants renamed to funder_org_cities.
Field funding_org_state in Grants renamed to funder_org_states.
Field funding_org_counties in Grants renamed to funder_org_countries.
Field funding_org_name in Grants renamed to funder_org_name.
Field funders in Grants renamed to funder_orgs.

Version 2.1.0 — 2022, April, Week of 11th

Deprecated field cited_by_ids in Patents. Use referece_ids to obtain citing patents instead.
Deprecated field repository_id in Datasets, use repository auxiliary entity and the associated field in Datasets.
New field funding_cny in Grants.
New field isbn in Publications.
Total number of records returned when using Unnesting multi-value entity fields is capped at 10000 records, as a performance and stability improvement.

Version 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:

The return <source> syntax is now optional (see the search source page)
New search field acknowledgements in publications
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.9.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

Source	Field	Deprecation Note
Grants	`funder_countries`	Deprecated in favor of: `funder_org_countries`
Grants	`funders`	Deprecated in favor of: `funder_orgs`
Grants	`funding_org_acronym`	Deprecated in favor of: `funder_org_acronym`
Grants	`funding_org_cities`	Deprecated in favor of: `funder_org_cities`
Grants	`funding_org_city`	Deprecated in favor of: `funder_org_cities`
Grants	`funding_org_name`	Deprecated in favor of: `funder_org_name`
Grants	`funding_org_states`	Deprecated in favor of: `funder_org_states`
Grants	`grant_number`	Deprecated in favor of: `project_numbers`
Patents	`cited_by_ids`	Use reference_ids field to filter patents citing this patent (see also: Patents Links section).
Clinical Trials	`date`	Deprecated in favor of: `start_date`
Datasets	`repository_id`	Deprecated in favor of: `repository`
Source Titles	`publisher`	The relevant field in the Publications source should be used instead. This is because one source title can have multiple publishers e.g. as a result of journals ownership changes.

Partially Deprecated Fields

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