Grants

This section provides information about the Grants source , listing each field available for Grants, 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 Grants, and each aggregation indicator available.

Note

By default, Grants is sorted by the start date, unless specified differently using Sorting Results option.

Grants Fields

Fields are used to perform searches on the source they belong to. Note: the emptiness filters can be used on any field, irrespectively of whether filtering / faceting is enabled on them.

Field	Type	Multi?	Filter?	Facet?	Description
abstract	Literal: string				Abstract or summary from a grant proposal.
active_status	Literal: string		✓	✓
active_year	Literal: integer	✓	✓	✓	List of active years for a grant.
category_bra	Entity: categories	✓	✓	✓	Broad Research Areas
category_for	Entity: categories	✓	✓	✓	ANZSRC Fields of Research classification (alias for most recent version).
category_for_2020	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
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. [1]
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 >=).
dimensions_url	Literal: string				Link pointing to the Dimensions web application
end_date	Literal: date		✓		Date when the grant ends.
foa_number	Literal: string		✓		The funding opportunity announcement (FOA) number, where available e.g. for grants from the US National Institute of Health (NIH) or from the National Science Foundation (NSF).
funder_org_acronym	Literal: string		✓	✓
funder_org_cities	Entity: cities	✓	✓	✓	City name for funding organisation.
funder_org_countries	Entity: countries	✓	✓	✓	The country linked to the organisation funding the grant, expressed as GeoNames codes.
funder_org_name	Literal: string		✓	✓	Name of funding organisation.
funder_org_states	Entity: states	✓	✓	✓	State name for funding organisation.
funder_orgs	Entity: organizations	✓	✓	✓	The organisation funding the grant. This is normally a GRID organisation, but in very few cases a Dimensions funder ID is used.
funding_aud	Literal: float		✓		Funding amount awarded in AUD.
funding_cad	Literal: float		✓		Funding amount awarded in CAD.
funding_chf	Literal: float		✓		Funding amount awarded in CHF.
funding_cny	Literal: float		✓		Funding amount awarded in CNY.
funding_currency	Literal: string		✓	✓	Original funding currency.
funding_eur	Literal: float		✓		Funding amount awarded in EUR.
funding_gbp	Literal: float		✓		Funding amount awarded in GBP.
funding_jpy	Literal: float		✓		Funding amount awarded in JPY.
funding_nzd	Literal: float		✓		Funding amount awarded in NZD.
funding_schemes	Literal: string	✓	✓		Information that the data sources provide regarding grouping of grants according to funding schemes, programs, mechanisms etc. NOTE: funding scheme labels are not normalised and hence cannot be safely used for aggregrations.
funding_usd	Literal: float		✓		Funding amount awarded in USD.
id	Literal: string		✓		Dimensions grant ID.
investigators	Literal: json		✓		Additional details about investigators, including affiliations and roles e.g. ‘PI’ or ‘Co-PI’ (note: if the investigator has a Dimensions researcher ID, that is returned as well). [2]
keywords	Literal: string	✓	✓	✓	Keywords provided by the original data source.
language	Literal: string		✓	✓	Grant original language, as ISO 639-1 language codes.
language_title	Literal: string		✓	✓	ISO 639-1 language code for the original grant title.
linkout	Literal: string				Original URL for the grant.
original_title	Literal: string				Title of the grant in its original language.
project_numbers	Literal: json		✓		Grant identifiers, as provided by the source (e.g., funder, aggregator) the grant was derived from.
research_org_cities	Entity: cities	✓	✓	✓	City of the research organisations receiving the grant, expressed as GeoNames id and name.
research_org_countries	Entity: countries	✓	✓	✓	Country of the research organisations receiving the grant, expressed as GeoNames code and name.
research_org_names	Literal: string	✓	✓		Names of organizations investigators 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 receiving the grant, expressed as GeoNames codes (ISO‌-3166-2).
research_org_types	Literal: string		✓	✓	Type of organisation to which investigators are affiliated. This field only contains information for organisations with GRID IDs.
research_orgs	Entity: organizations	✓	✓	✓	GRID organisations receiving the grant (note: identifiers are automatically extracted from the source text and can be missing in some cases).
researchers	Entity: researchers	✓	✓	✓	Dimensions researchers IDs associated to the grant.
score	Literal: float		✓		For full-text queries, the relevance score is a numerical value assigned to a document that indicates how relevant that document is for a given query. Note: the score is query-specific i.e. it cannot be used to compare documents across queries.
start_date	Literal: date		✓		Date when the grant starts, in the format ‘YYYY-MM-DD’.
start_year	Literal: integer		✓	✓	Year when the grant starts.
title	Literal: string				Title of the grant in English (if the grant language is not English, this field contains a translation of the title).

[1]

Returned objects contain: concept, relevance.

For example:

{
    "concepts_scores": [
        {
          "concept": "professional relations",
          "relevance": 0.08789352253426701
        },
        {
          "concept": "relation",
          "relevance": 0.062333122509877006
        },
        {
          "concept": "representation",
          "relevance": 0.025851134800039
        },
        {
          "concept": "skald",
          "relevance": 6.984149644517923e-05
        },
        {
          "concept": "Representations of Skalds",
          "relevance": 0.0
        },
        {
          "concept": "Sagas 1",
          "relevance": 0.0
        }
    ]
}  

[2]

Returned objects contain: id, first_name, middle_name, last_name, role, affiliations

For example:

{
    "investigator_details":[
        {
            "id":"ur.012516501745.79",
            "first_name":"O.",
            "middle_name":"",
            "last_name":"Mitas",
            "role":"PI",
            "affiliations":[
                {
                    "id":"grid.5477.1",
                    "name":"Breda University of Applied Sciences",
                    "city":null,
                    "city_id":"2745912",
                    "state":null,
                    "state_code":null,
                    "country":null,
                    "country_code":"NL"
                }
            ]
        }
    ]
}

Note

Please note that the yearly funding amounts are not cumulative. They represent the total funding available for a grant, replicated for all years the grant is active for.

Grants Links

The diagram below provides an overview of the outgoing links from Grants to other sources.

Grants Fieldsets

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

Fieldset	Fields
extras	funder_countries linkout researchers
categories	category_bra category_for category_hra category_hrcs_hc category_hrcs_rac category_icrp_cso category_icrp_ct category_rcdc category_uoa
basics	active_year end_date funder_org_name funder_orgs grant_number id language original_title start_date start_year title

Grants Indicators

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

Indicator	Description
funding	Total funding amount, in USD.
count	Total count

Please note that the yearly funding amounts are not cumulative. They represent the total funding available for a grant, replicated for all years the grant is active for. Use the funding_per_year function in order to obtain the cumulative funding per year.

Grants 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 only.
raw_affiliations	✓	Search within the raw names of the involved research organizations. Note: Depending on the selected content type the organizations can have different roles: Publications (author affiliation), Grants (funded organization/investigator affiliations), Patents (current and original assignee), Clinical trials (sponsor and collaborating organization). Boolean nesting to process phrases or words in a specified order is not supported.
investigators		Search for name and surname combinations in the investigators list of this grant (note: see the researchers search section for more details).
full_data	✓	The keyword will be searched for in all data fields that are found for that document. In cases where the full text is indexed in the background 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 grant.

Grants 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 2.10.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
funder_countries	Deprecated in favor of: funder_org_countries
funders	Deprecated in favor of: funder_orgs
funding_org_acronym	Deprecated in favor of: funder_org_acronym
funding_org_cities	Deprecated in favor of: funder_org_cities
funding_org_city	Deprecated in favor of: funder_org_cities
funding_org_name	Deprecated in favor of: funder_org_name
funding_org_states	Deprecated in favor of: funder_org_states
grant_number	Deprecated in favor of: project_numbers

Partially Deprecated Fields

Grants source has no partially deprecated fields.

Deprecated Search Indexes

Grants source has no deprecated search indexes.