NCncats
Taxonomy

Get a biocollection report by collection ID or code

Changed on

Get a biocollection report by collection ID or code in JSON format.

get/taxonomy/biocollections/id/{collection_ids}/dataset_report

Request

  • Base URL
    https://api.ncbi.nlm.nih.gov/datasets/v2
  • Auth
    API key in header api-key

Path parameters

collection_idsstring[] required

One or more collection IDs or codes

Query parameters

page_sizeinteger

The maximum number of biocollection reports to return. Default is 1000 and maximum is 1000. If the number of results exceeds the page size, page_token can be used to retrieve the remaining results.

page_tokenstring

A page token returned from a prior call with more than page_size results. Use this token with the same request parameters to retrieve the next page. When page_token is empty, all results have been retrieved.

sort.fieldstring
sort.direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASCENDING' | 'SORT_DIRECTION_DESCENDING'

Response

A successful response

total_countinteger
next_page_tokenstring

Changes