v1

latestOpenAPI 3.0.12026-08-06107337528.9 KB

Taxonomy

Get a taxonomy data report by taxon

Get a taxonomy data report by taxon. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.

get/taxonomy/taxon/{taxons}/dataset_report

Path parameters

taxonsstring[] required

Query parameters

returned_content'COMPLETE' | 'TAXIDS' | 'METADATA'

Return complete taxonomy reports, Taxonomy IDs only, or reports without assembly and gene counts (metadata).

page_sizeinteger

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

include_tabular_header'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'

Specify when to include the table header when requesting a tabular report.

page_tokenstring

A page token is returned when the results count exceeds page size. Use this token along with previous request parameters to retrieve the next page of results. When page_token is empty, all results have been retrieved.

table_format'SUMMARY'

Specify a predefined set of fields for the tabular report using built-in templates. Use of this parameter requires the HTTP header, accept: text/tab-separated-values.

childrenboolean

If true, return results for child taxa.

ranksV2reportsRankType[]

Limit results to taxa of the specified ranks.

Response

A successful response

total_countinteger

next_page_tokenstring