Searching publications

The search publication API endpoint searches all publications for a specific term.

Endpoint

https://gtr.ukri.org/api/search/publication?term=<term>

HTTP method

GET

Request parameters

Search API query parameters provides information about the request parameters.

Example

https://gtr.ukri.org/api/search/publication?term=mouse&page=1&fetchSize=25&selectedSortableField=&selectedSortOrder=&fields=pub.pro.abs

Example results

NOTE: Some items in the various lists included in the results below have been truncated to save space.

{
    "headerData": {
        "lastRefreshDate": "18 Apr 2024"
    },
    "facetedSearchResultBean": {
        "request": {
            "page": 1,
            "fetchSize": 25,
            "selectedSortableField": "",
            "selectedSortOrder": "",
            "term": "mouse",
            "fields": "pub.pro.abs",
            "selectedFacets": "",
            "type": "",
            "detailedAndFilter": false,
            "termEncoded": "mouse"
        },
        "totalResults": 4210,
        "didYouMean": [],
        "results": [
            {
                "publication": {
                    "id": "B6A8951A-C1C4-4D1A-A99F-BE21DD762886",
                    "resourceUrl": "https://gtr.ukri.org/publication/overview?outcomeid=5aa6a4d0d94053.31847835&projectref=EP/N011074/1",
                    "outcomeId": null,
                    "title": "A Novel Active Semisupervised Convolutional Neural Network Algorithm for SAR Image Recognition.",
                    "parentPublicationTitle": "Computational intelligence and neuroscience",
                    "authors": [
                        {
                            "id": "a8e49ffed5fb0d02ad5f6ec5fce26614",
                            "resourceUrl": "https://gtr.ukri.org/person/a8e49ffed5fb0d02ad5f6ec5fce26614",
                            "firstName": null,
                            "otherNames": "Gao F",
                            "surname": null,
                            "email": null,
                            "orcidId": null,
                            "displayName": "Gao F",
                            "fullName": "Gao F"
                        }
                    ],
                    "date": 1483228800000,
                    "digitalPublicationUrl": null,
                    "pubMedId": null,
                    "pubMedUrl": null,
                    "isbn": null,
                    "issn": null,
                    "publicationUrl": null,
                    "abstractText": null,
                    "volume": null,
                    "issue": null,
                    "totalPages": null,
                    "edition": null,
                    "chapterNumber": null,
                    "chapterTitle": null,
                    "pageRef": null,
                    "series": null,
                    "type": "Journal Article/Review",
                    "firstAuthorName": "Gao F",
                    "grantRef": null
                },
                "projects": null,
                "abstractSnippet": null
            },
            // ...
        ],
        "sortableFields": [
            {
                "fieldName": "score",
                "displayName": "Relevance"
            }
        ],
        "facetGroups": [
            {
                "name": "Type",
                "facets": [
                    {
                        "id": "dHlwZXxKb3VybmFsIEFydGljbGUvUmV2aWV3fHN0cmluZw==",
                        "applied": false,
                        "name": "Journal Article/Review",
                        "count": 3622
                    },
                    // ...
                    {
                        "id": "dHlwZXxXb3JraW5nIFBhcGVyfHN0cmluZw==",
                        "applied": false,
                        "name": "Working Paper",
                        "count": 1
                    }
                ],
                "sortOrder": "A"
            },
            {
                "name": "Funder",
                "facets": [
                    {
                        "id": "ZnVuZGVyfE1SQ3xzdHJpbmc=",
                        "applied": false,
                        "name": "MRC",
                        "count": 2126
                    },
                    // ...
                    {
                        "id": "ZnVuZGVyfEdDUkZ8c3RyaW5n",
                        "applied": false,
                        "name": "GCRF",
                        "count": 2
                    }
                ],
                "sortOrder": "A"
            },
            {
                "name": "Year",
                "facets": [
                    {
                        "id": "eWVhcnwxNzA0MDY3MjAwMDAwXzE3MzU2ODk1OTkwNTl8cmFuZ2U=",
                        "applied": false,
                        "name": "2024",
                        "count": 47
                    },
                    // ...
                    {
                        "id": "eWVhcnwxMTM2MDczNjAwMDAwXzExNjc2MDk1OTkwNTl8cmFuZ2U=",
                        "applied": false,
                        "name": "2006",
                        "count": 1
                    }
                ],
                "sortOrder": "D"
            }
        ],
        "resourceHitCounts": [
            {
                "resource": "publication",
                "count": 4210
            },
            {
                "resource": "outcomes",
                "count": 3260
            },
            {
                "resource": "project",
                "count": 3973
            },
            {
                "resource": "people",
                "count": 3338
            },
            {
                "resource": "organisation",
                "count": 1523
            },
            {
                "resource": "classificationproject",
                "count": 3097
            }
        ],
        "selectedFacets": "",
        "appliedSearchFields": "",
        "appliedSortField": "score",
        "appliedSortOrder": "DESC",
        "csvEndpoint": "publication/csv",
        "searchableFields": [
            {
                "fieldName": "pub.isbn",
                "displayName": "ISBN"
            },
            {
                "fieldName": "pub.issn",
                "displayName": "ISSN"
            },
            {
                "fieldName": "pub.orcidId",
                "displayName": "ORCID iD"
            },
            {
                "fieldName": "pub.a",
                "displayName": "Publication Abstract"
            },
            {
                "fieldName": "pub.t",
                "displayName": "Publication Title"
            }
        ],
        "downloadable": true,
        "childFacetGroups": null,
        "parentChildMap": null,
        "indexType": null,
        "numberOfSearchFieldDisplayColumns": 3,
        "page": 1,
        "fetchSize": 25,
        "paramsWithoutSortOrder": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&page=1&selectedSortableField=score",
        "paramsWithoutSortOrderOrSortField": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&page=1",
        "paramsWithoutPage": "term=mouse&selectedFacets=&fields=&type=&fetchSize=25&selectedSortableField=score&selectedSortOrder=DESC",
        "paramsWithoutFetchSize": "term=mouse&selectedFacets=&fields=&type=&page=1&selectedSortableField=score&selectedSortOrder=DESC",
        "totalPages": 169,
        "paginationStart": 1,
        "paginationEnd": 5
    }
}