Publications

This section provides information about the Publications source , listing each field available for Publications, with details about the field value type, including whether it may be used as a facet and whether it is a multi-value field. The table also contains information about whether the field may be used in the where section and whether the field the field may be used in the entity fields filter. The page also lists the fields included in each fieldset available for Publications, and each aggregation indicator available.

Publications Fields

Fields are used to perform searches on the source they belong to.

Field

Type

Multi?

Filter?

Facet?

Description

abstract

Literal: string

The publication abstract.

acknowledgements

Literal: string

The acknowledgements section text as found in the source document.

altmetric

Literal: float

Altmetric Attention Score.

altmetric_id

Literal: integer

Altmetric Publication ID

arxiv_id

Literal: string

The publications arXiv identifier (e.g. ‘arXiv:2102.02477’).

authors

Literal: json

Ordered list of authors names and their affiliations, as they appear in the original publication. The list can include researcher and organization identifiers, when available (note: in order to search for disambiguated authors, use the in researchers syntax). 1

authors_count

Literal: integer

Count of authors, as they appear in the original publication.

book_doi

Literal: string

The DOI of the book a chapter belongs to (note: this field is available only for chapters).

book_series_title

Literal: string

The title of the book series book, belong to.

book_title

Literal: string

The title of the book a chapter belongs to (note: this field is available only for chapters).

category_bra

Entity: categories

Broad Research Areas

category_for

Entity: categories

ANZSRC Fields of Research classification

category_hra

Entity: categories

Health Research Areas

category_hrcs_hc

Entity: categories

HRCS - Health Categories

category_hrcs_rac

Entity: categories

HRCS – Research Activity Codes

category_icrp_cso

Entity: categories

ICRP Common Scientific Outline

category_icrp_ct

Entity: categories

ICRP Cancer Types

category_rcdc

Entity: categories

Research, Condition, and Disease Categorization

category_sdg

Entity: categories

SDG - Sustainable Development Goals

category_uoa

Entity: categories

Units of Assessment

clinical_trial_ids

Literal: string

Clinical Trial IDs mentioned in publications full text.

concepts

Literal: json

Concepts describing the main topics of a publication (note: automatically derived from the publication text using machine learning).

concepts_scores

Literal: json

Relevancy scores for concepts. 2

date

Literal: date

The publication date for the version of record of a document (note: incomplete dates are always normalised as ‘YYYY-MM-DD’, so “2018-01” becomes “2018-01-01”.).

date_inserted

Literal: date

Date when the record was inserted into Dimensions (note: this field does not support exact match on the data, only range filters e.g. <= or `>=’).

date_online

Literal: string

The publication online date.

date_print

Literal: string

The publication print date.

dimensions_url

Literal: string

Link pointing to the Dimensions web application

doi

Literal: string

Digital object identifier.

field_citation_ratio

Literal: float

Relative citation performance of article when compared to similarly aged articles in its area of research (note: does not support emptiness filters).

funder_countries

Entity: countries

The country of the organisations funding this publication.

funders

Entity: organizations

The GRID organisation funding this publication.

id

Literal: string

Dimensions publication ID.

issn

Literal: string

International Standard Serial Number

issue

Literal: string

The issue number of a publication.

journal

Entity: journals

The journal a publication belongs to.

journal_lists

Literal: string

Independent grouping of journals outside of Dimensions, e.g. ‘ERA 2015’ or ‘Norwegian register level 1’.

journal_title_raw

Literal: string

The journal title, as it appears in the original source (note: this field can be used to retrieve historical titles of journals whose official title was later updated).

linkout

Literal: string

Original URL for a publication full text.

mesh_terms

Literal: string

Medical Subject Heading terms as used in PubMed.

open_access_categories_v2

Literal: string

Open Access categories for publications (latest version) 3

pages

Literal: string

The pages of the publication, as they would appear in a citation record.

pmcid

Literal: string

PubMed Central ID.

pmid

Literal: string

PubMed ID.

proceedings_title

Literal: string

Title of the conference proceedings volume associated to a publication.

publisher

Literal: string

Name of the publisher as a string.

recent_citations

Literal: integer

Number of citations received in the last two years. Does not support emptiness filters

reference_ids

Literal: string

Dimensions publication ID for publications in the references list, i.e. outgoing citations (see also: Publications Links section).

referenced_pubs

Entity: publication_links

Publication IDs of the publications in the references list, i.e. outgoing citations.

relative_citation_ratio

Literal: float

Relative citation performance of an article when compared to others in its area of research (note: does not support emptiness filters).

research_org_cities

Entity: cities

City of the organisations authors are affiliated to, expressed as GeoNames ID and name.

research_org_countries

Entity: countries

Country of the organisations authors are affiliated to, identified using GeoNames codes (note: this field supports count: count).

research_org_country_names

Literal: string

Country name of the organisations authors are affiliated to, as a string.

research_org_names

Literal: string

Names of organizations authors are affiliated to. If the organization has a GRID ID, the canonical organization name is used. Otherwise the original affiliation string is used.

research_org_state_codes

Entity: states

State of the organisations authors are affiliated to, expressed as GeoNames codes (ISO‌-3166-2).

research_org_state_names

Literal: string

State name of the organisations authors are affiliated to, as a string.

research_orgs

Entity: organizations

GRID organisations associated to a publication. Identifiers are automatically extracted from author affiliations text, so they can be missing in some cases (note: this field supports count: count).

researchers

Entity: researchers

Researcher IDs matched to the publication’s authors list. (note: this returns only the disambiguated authors of a publication; in order to get the full authors list, the field authors should be used). This field supports count: count.

resulting_publication_doi

Literal: string

For preprints, the DOIs of the resulting full publications.

source_title

Entity: source_titles

Source Title for the Publication.

subtitles

Literal: string

Subtitles of a publication (when available).

supporting_grant_ids

Literal: string

Grants supporting a publication, returned as a list of dimensions grants IDs (see also: Publications Links section).

times_cited

Literal: integer

Number of citations (note: does not support emptiness filters).

title

Literal: string

Title of a publication.

type

Literal: string

Publication type (one of: article, chapter, proceeding, monograph, preprint or book). Valid values: article book chapter monograph preprint proceeding

volume

Literal: string

Publication volume.

year

Literal: integer

The year for the version of record of publication (note: when the date field is available, this is equal to the year part of the full date).

1

Returned objects contain: first_name, last_name, corresponding, orcid, current_organization_id, researcher_id, affiliations and raw_affiliation.

For example:

{
    "raw_affiliation": [
        "Centre for Operational Research, International Union Against Tuberculosis and Lung Disease (The Union), Paris, France.",
        "Centre for Operational Research, The Union South-East Asia Office, New Delhi, India."
    ],
    "first_name": "Pruthu",
    "last_name": "Thekkur",
    "corresponding": "",
    "orcid": "['s']",
    "current_organization_id": "grid.435357.3",
    "researcher_id": "ur.0670077515.38",
    "affiliations": [
        {
            "raw_affiliation": "Centre for Operational Research, International Union Against Tuberculosis and Lung Disease (The Union), Paris, France.",
            "id": "grid.435357.3",
            "name": "International Union Against Tuberculosis and Lung Disease",
            "city": "Paris",
            "city_id": 2988507,
            "country": "France",
            "country_code": "FR",
            "state": null,
            "state_code": null
        },
        {
            "raw_affiliation": "Centre for Operational Research, The Union South-East Asia Office, New Delhi, India.",
            "id": "grid.8195.5",
            "name": "University of Delhi",
            "city": "New Delhi",
            "city_id": 1261481,
            "country": "India",
            "country_code": "IN",
            "state": null,
            "state_code": null
        }
    ]
}
2

Returned objects contain: concept, relevance.

For example:

{
    "concepts_scores": [
        {
          "concept": "professional relations",
          "relevance": 0.088
        },
        {
          "concept": "relation",
          "relevance": 0.062
        },
        {
          "concept": "representation",
          "relevance": 0.025
        },
        {
          "concept": "skald",
          "relevance": 6.984
        },
        {
          "concept": "Representations of Skalds",
          "relevance": 0.0
        },
        {
          "concept": "Sagas 1",
          "relevance": 0.0
        }
    ]
}  
3

Open Access category data for publications values:

  • oa_all: Publication is either gold, hybrid, bronze or green OA.

  • hybrid: Publication freely available under an open licence in a paid-access journal

  • bronze: Document freely available on publisher page, but without an open licence and not in a full OA journal

  • gold: Publication published in a full OA journal

  • green: Free copy of the publication available in an OA repository

  • closed: No freely available copy has been identified

Publications Fieldsets

Fieldsets are used to specify fields groups in the context of a return statement.

Fieldset

Fields

extras

altmetric date doi FOR funders open_access pmcid pmid references relative_citation_ratio research_org_cities research_org_countries research_org_country_names research_org_state_codes research_org_state_names research_orgs researchers times_cited

categories

category_bra category_for category_hra category_hrcs_hc category_hrcs_rac category_icrp_cso category_icrp_ct category_rcdc category_sdg category_ua

book

book_doi book_series_title book_title

basics

author_affiliations id issue journal pages title type volume year

Publications Indicators

Indicators are used to aggregate results in the context of a facet query.

Indicator

Description

recent_citations_total

For a given article, in a given year, the number of citations accrued in the last two year period. Single value stored per document, year window rolls over in July.

rcr_avg

Arithmetic mean of relative_citation_ratio field.

fcr_gavg

Geometric mean of field_citation_ratio field (note: This field cannot be used for sorting results).

count

Total count

citations_total

Aggregated number of citations

citations_median

Median of citations

citations_avg

Arithmetic mean of citations

altmetric_median

Median Altmetric Attention Score

altmetric_avg

Altmetric Attention Score mean

Publications Search Indexes

Search indexes are used to perform full-text searches on the source they belong to. The default search index, which is used if none other is specified, is full_data.

Search index

Supports multi-index search

Description

title_only

Search for keywords in title only.

title_abstract_only

The keywords will be searched for in the title and abstract fields. In addition, the following fields will be searched as well:

  • Various unique identifiers (Dimensions publication ID, DOI, Crossref ID, PubMed ID, PubMed Central ID, ReadCube ID);

  • MeSH Terms (for publications indexed in Medline).

full_data_exact

Search for keywords in the full text of a publication. This search index is not normalized(stemmed), so useful for searching exact terminology, such as gene names, chemical compounds etc.

full_data

The keyword will be searched for in all data fields that are found for that document, like affiliation, journal name, journal type, researcher name etc. as well as title and abstract. In cases where the full text is indexed in the background (roughly 70% of the publications in Dimensions) this will also be searched, even though the full text may not be available to see within Dimensions itself. This will mean that many results that are returned may not include mention of the searched keyword on the document page, but are returned in the search because the keyword can be found in the full text which cannot be read.

concepts

Search for keywords in the concepts list for this publication.

authors

Search for name and surname combinations in the authors list of this publication (note: see the researchers search section for more details).

Publications Deprecations

This section lists fields and search fields that have been deprecated and should not be used.

Warning

This fields will be supported in versions 1.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

Field

Deprecation Note

author_affiliations

Deprecated in favor of: authors

category_ua

Deprecated in favor of: category_uoa

FOR

Deprecated in favor of: category_for

FOR_first

Deprecated in favor of: category_for

HRCS_HC

Deprecated in favor of: category_hrcs_hc

HRCS_RAC

Deprecated in favor of: category_hrcs_rac

open_access

Deprecated in favor of: open_access_categories

open_access_categories

Deprecated in favor of: open_access_categories_v2

RCDC

Deprecated in favor of: category_rcdc

references

Deprecated in favor of: reference_ids

terms

Deprecated in favor of: concepts

Partially Deprecated Fields

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

Field

Deprecated Features

recent_citations

facet

research_org_state_names

facet

Deprecated Search Indexes

Search Index

Deprecation Note

terms

Deprecated in favor of: concepts

researchers

Deprecated in favor of: authors