v2

latestOpenAPI 3.1.02026-07-3171165552.0 KB

Collections

Create a custom collection (called Dashboards in the UI) from a list of DOIs or a search query

Either 'dois' or 'query' is required to create a dashboard. If both are provided, 'query' will be used.

post/api_partner/collections/create

Headers

authorizationstring

Set to Bearer <token> to pass token for authorization.

Request body

namestring required

emailstring email required

descriptionstring nullable

isPublicboolean

isHiddenboolean

isSharedWithOrgboolean

doisstring[] nullable

enableDashboardCitationAlertsboolean

Example request

{
  "query": {
    "term": "mitosis",
    "mode": "citations",
    "limit": 100,
    "offset": 10,
    "sort": "total_supported",
    "title": "Cellular",
    "abstract": "Amygdala",
    "doi": "10.1002/cepa.3344",
    "dois": [
      "10.1002/cepa.3344"
    ],
    "dateTo": "2001-05-04",
    "hasRetraction": true,
    "hasConcern": true,
    "hasCorrection": true,
    "hasErratum": true,
    "hasWithdrawn": true,
    "hasTally": true,
    "supportingTo": 1,
    "mentioningFrom": 100,
    "mentioningTo": 500,
    "contrastingFrom": 5,
    "citingPublicationsFrom": 5,
    "author": "Albert Einstein",
    "journal": "Nature",
    "publisher": "Elsevier",
    "affiliation": "Stanford University",
    "topic": "Diplomacy",
    "aggregations": [
      "authors",
      "journals"
    ]
  }
}

Response

Successful Response

idinteger required

namestring required

descriptionstring

slugstring nullable

dashboardTypestring nullable

isPublicboolean

organizationSlugstring nullable

lastUpdatedstring date nullable

doisUpdatedTSstring date-time nullable

doisRefreshedTSstring date-time nullable

refreshStatusstring

accessTypestring nullable

totalDoiCountinteger

matchedDoiCountinteger

unmatchedDoiCountinteger

warningstring nullable