---
title: "Create a custom collection (called Dashboards in the UI) from a list of DOIs or a search query"
method: POST
path: "/api_partner/collections/create"
tags: ["Collections"]
---

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

`POST /api_partner/collections/create`

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

## Headers

- `authorization` string — Set to `Bearer <token>` to pass token for authorization.

## Request body

- PartnerCreateDashboardRQ
  - `name` string, required
  - `email` string, email, required
  - `description` string, nullable
  - `isPublic` boolean
  - `isHidden` boolean
  - `isSharedWithOrg` boolean
  - `dois` string[], nullable
  - `query` QuerySchemaV2
    - `term` string, nullable — Cross-field search term. Can be left blank.
    - `mode` 'all' | 'citations' | 'papers' | 'question-answering' — Select search mode, see above.
    - `limit` integer — How many results to fetch. Up to 10,000 can be fetched at once.
    - `offset` integer — Can be used for pagination in combination with `limit`.
    - `sort` 'date' | 'total_cited' | 'total_supported' | 'total_contrasted' | 'total_mentioned' | 'total_citing_publications', nullable — How the results should be sorted. Leave blank for generic query 'relevance'.
    - `sortOrder` 'asc' | 'desc', nullable — Result sort order for selected sort.
    - `title` string, nullable — Match text in publication title.
    - `abstract` string, nullable — Match text in publication abstract.
    - `doi` string, nullable — Scope the search to a single DOI (exact match). Convenience alias for a one-element `dois`. Combine with `term` to search within a known publication.
    - `dois` string[] — Scope the search to one or more specific DOIs (exact match). Combine with `term` to search within a known publication.
    - `dateFrom` string, nullable — Match publications published from this date onwards (YYYY-MM-DD or just YYYY).
    - `dateTo` string, nullable — Match publications published up to this date (YYYY-MM-DD or just YYYY).
    - `indexedFrom` string, nullable — Match only records indexed from this time
    - `citationTypes` string[] — Match smart citations of certain types.
    - `hasRetraction` boolean, nullable — Publication has retraction or not.
    - `hasConcern` boolean, nullable — Publication has editorial concern or not.
    - `hasCorrection` boolean, nullable — Publication has correction or not.
    - `hasErratum` boolean, nullable — Publication has erratum or not.
    - `hasWithdrawn` boolean, nullable — Publication has been withdrawn or not.
    - `hasTally` boolean, nullable — Publication has smart citations made towards it or not (i.e. a scite tally of > 0).
    - `supportingFrom` integer, nullable — Number of supporting citations made from publication. Leave blank for any count.
    - `supportingTo` integer, nullable — Number of supporting citations made toward publication. Leave blank for any count.
    - `mentioningFrom` integer, nullable — Number of mentioning citations made from publication. Leave blank for any count.
    - `mentioningTo` integer, nullable — Number of mentioning citations made toward publication. Leave blank for any count.
    - `contrastingFrom` integer, nullable — Number of contrasting citations made from publication. Leave blank for any count.
    - `contrastingTo` integer, nullable — Number of contrasting citations made toward publication. Leave blank for any count.
    - `citingPublicationsFrom` integer, nullable — Number of traditional citations made from publication AKA the number of references. Leave blank for any count.
    - `citingPublicationsTo` integer, nullable — Number of traditional citations made toward publication. Leave blank for any count.
    - `author` string, nullable — Publication author name.
    - `authors` string[]
    - `journal` string, nullable — Journal in which publication appears.
    - `journals` string[]
    - `publisher` string, nullable — Publisher of the publication.
    - `section` string, nullable — Publication section in which citation statement appears.
    - `sections` string[]
    - `paperType` string, nullable — Publication type.
    - `paperTypes` string[]
    - `affiliation` string, nullable — Author affiliation.
    - `affiliations` string[]
    - `topic` string, nullable — Publication topic.
    - `topics` string[]
    - `substances` string[] — Pubchem substance canonical name.
    - `meshType` string[] — Pubmed mesh descriptor and/or qualifier for publication.
    - `dashboardSlug` string, nullable
    - `dashboardDoiSource` 'manual' | 'search', nullable — For a dashboard search, restrict results to manually-added papers ('manual') or search-result papers ('search'). Defaults to all papers in the collection.
    - `computeAggregations` boolean — For a given search query, this flag will control whether counts are computed and returned for the possible aggregations.
    - `aggregations` string[] — List of aggregation types to compute counts for. Only used if `compute_aggregations` is true.
    - `aggregationsOptions` string
  - `enableDashboardCitationAlerts` boolean

## Response `200`

Successful Response

- CustomDashboardSchema
  - `id` integer, required
  - `name` string, required
  - `description` string
  - `slug` string, nullable
  - `dashboardType` string, nullable
  - `isPublic` boolean
  - `organizationSlug` string, nullable
  - `componentLayout` DashboardComponentLayoutSchema[], required
    - `_id` integer, nullable
    - `components` DashboardComponent[], required
      - `_id` integer, nullable
      - `name` string, required
      - `width` integer, nullable
  - `doiQuery` DashboardDoiQuerySchema, required
    - `queryType` 'list' | 'saved_search', nullable
    - `query` union, required
      - DashboardManualListQuerySchema
        - `dois` string[], required
      - DashboardSavedSearchQuerySchema
        - `saved_search_id` integer, required
        - `doi_exclude_list` string[], nullable
        - `dois` string[], nullable
  - `lastUpdated` string, date, nullable
  - `doisUpdatedTS` string, date-time, nullable
  - `doisRefreshedTS` string, date-time, nullable
  - `refreshStatus` string
  - `accessType` string, nullable
  - `totalDoiCount` integer
  - `matchedDoiCount` integer
  - `unmatchedDoiCount` integer
  - `unmatchedDois` unknown[]
    - unknown
  - `warning` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/scite/apis/scite-api.md) · [All operations](https://skmtc.net/scite/apis/scite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scite/scite-api/revisions/9f4cba020e89/schema)