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.4.0 — 2022, November, Week of 7th

  1. New field funding_section in Publications.

  2. Field category_for now points to category_for_2020 in all relevant content sources.

  3. New feature Searching using abstracts is available for Publications.

  4. New fields funding_schemes, keywords for Grants.

Version 2.3.0 — 2022, October, Week of 3rd

  1. Field current_organization_id of the authors field in Publications is now deprecated. Please use the current_research_org field in the Researchers source.

  2. 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

  1. Field funding_org_acronym in Grants renamed to funder_org_acronym.

  2. Field funding_org_city in Grants renamed to funder_org_cities.

  3. Field funding_org_state in Grants renamed to funder_org_states.

  4. Field funding_org_counties in Grants renamed to funder_org_countries.

  5. Field funding_org_name in Grants renamed to funder_org_name.

  6. Field funders in Grants renamed to funder_orgs.

Version 2.1.0 — 2022, April, Week of 11th

  1. Deprecated field cited_by_ids in Patents. Use referece_ids to obtain citing patents instead.

  2. Deprecated field repository_id in Datasets, use repository auxiliary entity and the associated field in Datasets.

  3. New field funding_cny in Grants.

  4. New field isbn in Publications.

  5. 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:

  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.4.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

Patents

cited_by_ids

Use reference_ids field to filter patents citing this patent (see also: Patents Links section).

Datasets

repository_id

Deprecated in favor of: repository

Partially Deprecated Fields

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

Deprecated Search Indexes

Deprecated Functions