Release Notes and Deprecations =============================== .. _versions-history: Versions History -------------------------------- This page contains version history information for the version 2 of the Dimensions Analytics API. .. note:: These release notes also apply to the :ref:`CRIS API `, which is built on the same query language and follows the same versioning. Entries concerning features not available on the CRIS API — faceting and expert identification — can be disregarded there. .. note:: Older release notes are available on the legacy `API Version 1 `_ documentation. Dimensions Analytics MCP Release Notes, 2026, October, Week of 12th +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #. The :ref:`hosted MCP server ` is available at ``https://app.dimensions.ai/mcp``. Clients that can send an ``Authorization: Bearer`` header (Cursor, VS Code, Windsurf, Claude Code, Codex CLI) connect with your API key, with nothing to install. The guided installer can configure it. Dimensions Analytics MCP Release Notes, 2026, August, Week of 10th ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #. New MCP server :ref:`mcp` is released. Version 2.16 --- 2026, September, Week of 14th +++++++++++++++++++++++++++++++++++++++++++++++++ #. New fields `retracted`, `expression_of_concern`, `retraction_details` and `expression_of_concern_details` in :ref:`publications`. `retracted` and `expression_of_concern` are filterable and facetable (``= "true"`` / ``= "false"``). The details fields return notice id, reasons, and (for retractions) date. #. Fixed ``classify()`` sending ``SDG_2021`` to the classification service. ``SDG`` and ``SDG_2021`` now both request system ``SDG``. Version 2.15 --- 2026, May, Week of 4th +++++++++++++++++++++++++++++++++++++++++++++++++ #. New optional argument `limit` for the `similar_documents` function, which specifies the maximum number of concepts to be extracted from the abstract. By default, the limit is set to 250 concepts, and it cannot exceed 2000 concepts. For more details, see :ref:`abstract-search-main`. #. New field `concepts_relevant` in :ref:`publications`, which includes concepts describing the main topics of a publication (note: automatically derived from the publication text using machine learning). The field includes all concepts with a concept relevance score of 0.6 or higher. #. Deprecated fields `research_org_country_names` in favor of `research_org_countries` and `research_org_state_names` in favor of `research_org_states` in :ref:`publications`. #. Deprecated fields `title_language` and `language_desc` in favor of `language_detected` in :ref:`datasets`. #. Deprecated field `acronym` in favor of `acronyms` in :ref:`organizations`. #. Deprecated field `funder_org_acronym` in favor of `funders` in :ref:`grants`. `funders` entity contains field `acronyms` which includes the acronyms of the funder organizations. Version 2.14 --- 2026, February, Week of 2nd +++++++++++++++++++++++++++++++++++++++++++++++++ #. New fields `ultimate_parent_id` and `hierarchy_details` in :ref:`organizations`. Version 2.13 --- 2025, November, Week of 10th +++++++++++++++++++++++++++++++++++++++++++++++++ #. New field `overall_status` and `resulting_publications` in :ref:`clinical_trials`. #. Fields `last_year` and `total_publications` in :ref:`source_titles` are deprecated as data for them is not available. Version 2.12 --- 2025, July, Week of 28th +++++++++++++++++++++++++++++++++++++++++++++++++ #. :ref:`source_titles` are sorted by the score by default. #. Field `active_status` in :ref:`grants` can now be retrieved in the response. It can also be used with ``empty`` and ``not empty`` filters. #. New field `last_year` and `total_publications` in :ref:`source_titles`. #. Field `current_organization_id` in `authors in :ref:`publications` is no longer deprecated. #. New search field `funding` in :ref:`publications`. It allows searching for keywords in the funding section of a publication. #. New search field `title_abstract_claims` in :ref:`patents`. It allows searching for keywords in the title, abstract and claims of a patent. Version 2.10.1 --- 2024, August, Week of 28th +++++++++++++++++++++++++++++++++++++++++++++++++ #. Fixed bug related to :ref:`reports` field `orange_book`. #. Fixed bug of incorrect return value for `classify` function. Version 2.10.0 --- 2024, April, Week of 29th +++++++++++++++++++++++++++++++++++++++++++++++++ #. New operator :ref:`raw-lucene-matching`. #. Updated classification system ``SDG`` in the ``classify()`` function call. #. New field `research_org_types` in :ref:`publications` and :ref:`grants`. Version 2.9.1 --- 2024, February, Week of 12th +++++++++++++++++++++++++++++++++++++++++++++++++ #. Fixed issue regarding returning 408 after a short period of time. #. :ref:`researchers` are now by default filtered for obsolete researchers. #. Updated version of `concepts`, `RCDC` and `UoA` fields. #. :ref:`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 :ref:`publications`. #. New return functions `prettify` which provides semicolon separated string for multi value fields. #. New field `active_status` in :ref:`grants`. Version 2.8.0 --- 2023, September, Week of 25th +++++++++++++++++++++++++++++++++++++++++++++++++ #. Function :ref:`abstract-search-main` now supported for :ref:`grants` sources as well. #. New search index `concepts` in the :ref:`reports` core. #. New field `kind` in :ref:`patents` core. #. New field `journal_lists` in :ref:`source_titles` core. #. Field `category_for_2008` removed from all relevant sources. #. Documentation about hyperauthorship truncation of results has been updated, see :ref:`paging-errors`. #. Documentation about which sources support multi-index search has been updated, see :ref:`multi-index-search`. Version 2.7.0 --- 2023, May, Week of 22nd +++++++++++++++++++++++++++++++++++++++++++++++++ #. New search field `assignees` in :ref:`patents`. #. New fields `application_number`, `family_count` and `filing_date` in :ref:`patents`. #. New search field `raw_affiliations` in :ref:`grants`. #. New search field `raw_affiliations` in :ref:`clinical_trials`. #. Field `publisher` in :ref:`source_titles` is deprecated, see :ref:`deprecated-fields`. Version 2.6.0 --- 2023, February, Week of 13th +++++++++++++++++++++++++++++++++++++++++++++++++ #. New sources :ref:`funder_groups` and :ref:`research_org_groups`. #. New fields `orange_book`, `federal_support` and `claims_amount` in :ref:`patents`. #. New field `country_code` in :ref:`organizations`. #. New fields `start_date` and `end_date` in :ref:`clinical_trials`. Field `date` is now deprecated in favor of `start_date`. #. Field `project_number` in :ref:`grants` enabled for filtering. #. New documentation section :ref:`techinical-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 :ref:`grants`. Version 2.4.0 --- 2022, November, Week of 7th +++++++++++++++++++++++++++++++++++++++++++++++++ #. New field `funding_section` in :ref:`publications`. #. Field `category_for` now points to `category_for_2020` in all relevant content sources. #. New feature :ref:`abstract-search-main` is available for :ref:`publications`. #. New fields `funding_schemes`, `keywords` for :ref:`grants`. Version 2.3.0 --- 2022, October, Week of 3rd +++++++++++++++++++++++++++++++++++++++++++++++++ #. Field `current_organization_id` of the `authors` field in :ref:`publications` is now deprecated. Please use the `current_research_org` field in the :ref:`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 :ref:`grants` renamed to `funder_org_acronym`. #. Field `funding_org_city` in :ref:`grants` renamed to `funder_org_cities`. #. Field `funding_org_state` in :ref:`grants` renamed to `funder_org_states`. #. Field `funding_org_counties` in :ref:`grants` renamed to `funder_org_countries`. #. Field `funding_org_name` in :ref:`grants` renamed to `funder_org_name`. #. Field `funders` in :ref:`grants` renamed to `funder_orgs`. Version 2.1.0 --- 2022, April, Week of 11th +++++++++++++++++++++++++++++++++++++++++++++++++ #. Deprecated field `cited_by_ids` in :ref:`patents`. Use `referece_ids` to obtain citing patents instead. #. Deprecated field `repository_id` in :ref:`datasets`, use `repository` auxiliary entity and the associated field in :ref:`datasets`. #. New field `funding_cny` in :ref:`grants`. #. New field `isbn` in :ref:`publications`. #. Total number of records returned when using :ref:`unnesting-results` 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. New features: #. The `return ` syntax is now optional (see the :ref:`search source ` page) #. New search field `acknowledgements` in :ref:`publications ` #. :ref:`Triple quotes syntax ` for full-text search ================================================ .. _deprecated-fields: 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). Deprecated Fields +++++++++++++++++++ .. jinja:: config .. list-table:: :widths: auto :header-rows: 1 * - Source - Field - Deprecation Note {% for source_name, source in config.sources.items() %} {% for field in source.fields.values()|selectattr("is_documented")|selectattr("deprecated")|sort %} * - :ref:`{{ source_name }}` - ``{{ field.name }}`` {% if field.deprecated != True %} - Deprecated in favor of: ``{{ field.deprecated }}`` {% else %} - {{ field.description }} {% endif %} {% endfor %} {% endfor %} Partially Deprecated Fields +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ On the following fields only certain features are deprecated (e.g. filtering or faceting). .. jinja:: config {% set ns = namespace(rows=[]) %} {% for source_name, source in config.sources.items() %} {% for field in source.fields.values()|selectattr("is_documented")|selectattr("deprecated_features")|sort %} {% set ns.rows = ns.rows + [(source_name, field)] %} {% endfor %} {% endfor %} {% if ns.rows %} .. list-table:: :widths: auto :header-rows: 1 * - Source - Field - Deprecated Features {% for source_name, field in ns.rows %} * - :ref:`{{ source_name }}` - ``{{ field.name }}`` - {% for feature in field.deprecated_features %}**{{ feature }}** {% endfor %} {% endfor %} {% else %} There are currently no partially deprecated fields. {% endif %} Deprecated Search Indexes +++++++++++++++++++++++++++ .. jinja:: config {% set ns = namespace(rows=[]) %} {% for source_name, source in config.sources.items() %} {% for search_field_name, search_field in source.search_fields_raw|dictsort|reverse %} {% if search_field.deprecated %} {% set ns.rows = ns.rows + [(source_name, search_field_name, search_field)] %} {% endif %} {% endfor %} {% endfor %} {% if ns.rows %} .. list-table:: :widths: auto :header-rows: 1 * - Source - Search Index - Deprecation Note {% for source_name, search_field_name, search_field in ns.rows %} * - :ref:`{{ source_name }}` - ``{{ search_field_name }}`` {% if search_field.deprecated != True %} - Deprecated in favor of: ``{{ search_field.deprecated }}`` {% else %} - {{ search_field.description }} {% endif %} {% endfor %} {% else %} There are currently no deprecated search indexes. {% endif %} Deprecated Functions ++++++++++++++++++++ .. jinja:: fun_expression_specs {% set deprecated_funs = CALL_FUN_EXPRESSIONS_DOCS|dictsort|selectattr("1.2")|list %} {% if deprecated_funs %} .. list-table:: :widths: auto :header-rows: 1 * - Function - Deprecation Note {% for name, (spec_args, description, deprecated) in deprecated_funs %} * - ``{{ name }}`` - Deprecated in favor of: ``{{ deprecated }}`` {% endfor %} {% else %} There are currently no deprecated functions. {% endif %}