--- title: "Get a gene data report" method: POST path: "/gene/dataset_report" tags: ["Gene"] --- # Get a gene data report `POST /gene/dataset_report` Get a gene data report. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats. ## Request body - V2GeneDatasetReportsRequest - `returned_content` 'COMPLETE' | 'IDS_ONLY' | 'COUNTS_ONLY' - `gene_ids` integer[] - `accessions` string[] - `symbols_for_taxon` V2GeneDatasetReportsRequestSymbolsForTaxon - `symbols` string[] - `taxon` string - `taxon` string - `locus_tags` string[] - `table_fields` string[] - `table_format` string - `include_tabular_header` 'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER' - `page_size` integer - `page_token` string - `query` string - `types` V2GeneType[] - `accession_filter` string[] - `tax_search_subtree` boolean - `sort` V2SortField[] - `field` string - `direction` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASCENDING' | 'SORT_DIRECTION_DESCENDING' ## Response `200` A successful response - V2reportsGeneDataReportPage - `reports` V2reportsGeneReportMatch[] - `gene` V2reportsGeneDescriptor - `gene_id` string, uint64 - `symbol` string - `description` string - `tax_id` string, uint64 - `taxname` string - `common_name` string - `type` 'UNKNOWN' | 'tRNA' | 'rRNA' | 'snRNA' | 'scRNA' | 'snoRNA' | 'PROTEIN_CODING' | 'PSEUDO' | 'TRANSPOSON' | 'miscRNA' | 'ncRNA' | 'BIOLOGICAL_REGION' | 'OTHER' - `rna_type` 'rna_UNKNOWN' | 'premsg' | 'tmRna' - `orientation` 'none' | 'plus' | 'minus' - `reference_standards` V2reportsGenomicRegion[] - `gene_range` V2reportsSeqRangeSet - `accession_version` string - `range` V2reportsRange[] - `begin` string, uint64 - `end` string, uint64 - `orientation` 'none' | 'plus' | 'minus' - `order` integer - `ribosomal_slippage` integer - `type` 'UNKNOWN' | 'REFSEQ_GENE' | 'PSEUDOGENE' | 'BIOLOGICAL_REGION' | 'OTHER' - `genomic_regions` V2reportsGenomicRegion[] - `gene_range` V2reportsSeqRangeSet - `accession_version` string - `range` V2reportsRange[] - `begin` string, uint64 - `end` string, uint64 - `orientation` 'none' | 'plus' | 'minus' - `order` integer - `ribosomal_slippage` integer - `type` 'UNKNOWN' | 'REFSEQ_GENE' | 'PSEUDOGENE' | 'BIOLOGICAL_REGION' | 'OTHER' - `chromosomes` string[] - `nomenclature_authority` V2reportsNomenclatureAuthority - `authority` string - `identifier` string - `swiss_prot_accessions` string[] - `ensembl_gene_ids` string[] - `omim_ids` string[] - `synonyms` string[] - `alternate_names` string[] - `replaced_gene_id` string, uint64 - `annotations` V2reportsAnnotation[] - `assembly_accession` string - `assembly_name` string - `annotation_name` string - `annotation_release_date` string - `genomic_locations` V2reportsGenomicLocation[] - `genomic_accession_version` string - `sequence_name` string - `genomic_range` V2reportsRange - `begin` string, uint64 - `end` string, uint64 - `orientation` 'none' | 'plus' | 'minus' - `order` integer - `ribosomal_slippage` integer - `exons` V2reportsRange[] - `begin` string, uint64 - `end` string, uint64 - `orientation` 'none' | 'plus' | 'minus' - `order` integer - `ribosomal_slippage` integer - `transcript_count` integer - `protein_count` integer - `transcript_type_counts` V2reportsTranscriptTypeCount[] - `type` 'UNKNOWN' | 'PROTEIN_CODING' | 'NON_CODING' | 'PROTEIN_CODING_MODEL' | 'NON_CODING_MODEL' - `count` integer - `gene_groups` V2reportsGeneGroup[] - `id` string - `method` string - `summary` V2reportsGeneSummary[] - `source` string - `description` string - `date` string - `gene_ontology` V2reportsGeneOntology - `assigned_by` string - `molecular_functions` V2reportsProcessMetadata[] - `name` string - `go_id` string - `evidence_code` string - `qualifier` string - `reference` V2reportsReference - `pmids` string[] - `biological_processes` V2reportsProcessMetadata[] - `name` string - `go_id` string - `evidence_code` string - `qualifier` string - `reference` V2reportsReference - `pmids` string[] - `cellular_components` V2reportsProcessMetadata[] - `name` string - `go_id` string - `evidence_code` string - `qualifier` string - `reference` V2reportsReference - `pmids` string[] - `locus_tag` string - `map_locations` V2reportsMapLocation[] - `map_type` 'Unknown' | 'Cytogenetic' | 'Genetic' - `map_value` string - `product` V2reportsProductDescriptor - `gene_id` string, uint64 - `symbol` string - `description` string - `tax_id` string, uint64 - `taxname` string - `common_name` string - `type` 'UNKNOWN' | 'tRNA' | 'rRNA' | 'snRNA' | 'scRNA' | 'snoRNA' | 'PROTEIN_CODING' | 'PSEUDO' | 'TRANSPOSON' | 'miscRNA' | 'ncRNA' | 'BIOLOGICAL_REGION' | 'OTHER' - `rna_type` 'rna_UNKNOWN' | 'premsg' | 'tmRna' - `transcripts` V2reportsTranscript[] - `accession_version` string - `name` string - `length` integer - `cds` V2reportsSeqRangeSet - `accession_version` string - `range` V2reportsRange[] - `begin` string, uint64 - `end` string, uint64 - `orientation` 'none' | 'plus' | 'minus' - `order` integer - `ribosomal_slippage` integer - `genomic_locations` V2reportsGenomicLocation[] - `genomic_accession_version` string - `sequence_name` string - `genomic_range` V2reportsRange - `begin` string, uint64 - `end` string, uint64 - `orientation` 'none' | 'plus' | 'minus' - `order` integer - `ribosomal_slippage` integer - `exons` V2reportsRange[] - `begin` string, uint64 - `end` string, uint64 - `orientation` 'none' | 'plus' | 'minus' - `order` integer - `ribosomal_slippage` integer - `ensembl_transcript` string - `protein` V2reportsProtein - `accession_version` string - `name` string - `length` integer - `isoform_name` string - `ensembl_protein` string - `mature_peptides` V2reportsMaturePeptide[] - `accession_version` string - `name` string - `length` integer - `type` 'UNKNOWN' | 'PROTEIN_CODING' | 'NON_CODING' | 'PROTEIN_CODING_MODEL' | 'NON_CODING_MODEL' - `select_category` 'SELECT_UNKNOWN' | 'REFSEQ_SELECT' | 'MANE_SELECT' | 'MANE_PLUS_CLINICAL' - `transcript_count` integer - `protein_count` integer - `transcript_type_counts` V2reportsTranscriptTypeCount[] - `type` 'UNKNOWN' | 'PROTEIN_CODING' | 'NON_CODING' | 'PROTEIN_CODING_MODEL' | 'NON_CODING_MODEL' - `count` integer - `expression` V2reportsExpressionDescriptor - `gene_id` string, uint64 - `expression_release` V2reportsExpressionRelease - `release_name` string - `assembly_accession` string - `expression_method` string - `bioprojects` V2reportsExpressionBioProject[] - `accession` string - `study_title` string - `description` string - `sra_study_accession` string - `pmid` string, uint64 - `samples` V2reportsSample[] - `sample_name` string - `aggregate_expression_value` V2reportsAggregateExpressionValue - `mean` number, float - `stddev` number, float - `biosamples` V2reportsBioSample[] - `accession` string - `sra_runs` V2reportsSraRun[] - … - `query` string[] - `warnings` V2reportsWarning[] - `gene_warning_code` 'UNKNOWN_GENE_WARNING_CODE' | 'ACCESSION_VERSION_MISMATCH' | 'REPLACED_GENE_ID' | 'DISCONTINUED_GENE_ID' | 'UNRECOGNIZED_GENE_ID' | 'UNRECOGNIZED_GENE_SYMBOL' | 'UNRECOGNIZED_ACCESSION' | 'UNRECOGNIZED_TAX_TOKEN' | 'NO_GENE_ANNOTATION_FOUND' | 'ABOVE_SPECIES_TAXON' - `reason` string - `message` string - `replaced_id` V2reportsWarningReplacedId - `requested` string - `returned` string - `unrecognized_identifier` string - `warning` V2reportsWarning - `gene_warning_code` 'UNKNOWN_GENE_WARNING_CODE' | 'ACCESSION_VERSION_MISMATCH' | 'REPLACED_GENE_ID' | 'DISCONTINUED_GENE_ID' | 'UNRECOGNIZED_GENE_ID' | 'UNRECOGNIZED_GENE_SYMBOL' | 'UNRECOGNIZED_ACCESSION' | 'UNRECOGNIZED_TAX_TOKEN' | 'NO_GENE_ANNOTATION_FOUND' | 'ABOVE_SPECIES_TAXON' - `reason` string - `message` string - `replaced_id` V2reportsWarningReplacedId - `requested` string - `returned` string - `unrecognized_identifier` string - `errors` V2reportsError[] - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS' - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT' - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION' - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE' - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON' - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION' - `reason` string - `message` string - `invalid_identifiers` string[] - `messages` V2reportsMessage[] - `error` V2reportsError - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS' - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT' - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION' - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE' - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON' - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION' - `reason` string - `message` string - `invalid_identifiers` string[] - `warning` V2reportsWarning - `gene_warning_code` 'UNKNOWN_GENE_WARNING_CODE' | 'ACCESSION_VERSION_MISMATCH' | 'REPLACED_GENE_ID' | 'DISCONTINUED_GENE_ID' | 'UNRECOGNIZED_GENE_ID' | 'UNRECOGNIZED_GENE_SYMBOL' | 'UNRECOGNIZED_ACCESSION' | 'UNRECOGNIZED_TAX_TOKEN' | 'NO_GENE_ANNOTATION_FOUND' | 'ABOVE_SPECIES_TAXON' - `reason` string - `message` string - `replaced_id` V2reportsWarningReplacedId - `requested` string - `returned` string - `unrecognized_identifier` string - `total_count` integer - `next_page_token` string ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/ncats/apis/ncbi-datasets-api.md) · [All operations](https://skmtc.net/ncats/apis/ncbi-datasets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ncats/ncbi-datasets-api/versions/e5d4400c8e5d/schema)