variants

Query processed variants with filters and pagination

get/sessions/{session_id}/variants

Request

Path parameters

session_idstring uuid required

Query parameters

acmg_classstring[] nullable

ACMG classifications

min_confidencenumber nullable
min_priority_scorenumber nullable
gene_symbolstring[] nullable

Gene symbols (supports partial match)

consequencestring[] nullable
impactstring[] nullable

Impact levels

max_gnomad_afnumber nullable
include_unknown_afboolean
min_depthinteger nullable
min_qualitynumber nullable
min_vafnumber nullable
max_vafnumber nullable
sv_onlyboolean

Return only rows whose canonical sv_type is non-null

sv_groupstring nullable
sv_querystring nullable
pageinteger

Page number

page_sizeinteger

Results per page

sort_bystring

Sort column

sort_orderstring

Sort order (ASC/DESC)

chromosomestring[] nullable
variant_typestring[] nullable
genotypestring[] nullable
inheritance_modestring[] nullable
biotypestring[] nullable
acmg_criterionstring[] nullable
clinvar_significancestring[] nullable
start_positioninteger nullable
end_positioninteger nullable
has_hpoboolean nullable
min_review_starsinteger nullable
quality_statusstring[] nullable
source_filterstring[] nullable
min_genotype_qualitynumber nullable
min_sift_scorenumber nullable
max_sift_scorenumber nullable
min_alphamissense_scorenumber nullable
max_alphamissense_scorenumber nullable
min_metasvm_scorenumber nullable
max_metasvm_scorenumber nullable
min_dann_scorenumber nullable
max_dann_scorenumber nullable
min_phylop100way_vertebratenumber nullable
max_phylop100way_vertebratenumber nullable
min_gerp_rsnumber nullable
max_gerp_rsnumber nullable
min_bayesdel_addaf_scorenumber nullable
max_bayesdel_addaf_scorenumber nullable
min_bayesdel_noaf_scorenumber nullable
max_bayesdel_noaf_scorenumber nullable
min_mpc_scorenumber nullable
max_mpc_scorenumber nullable
min_spliceai_max_scorenumber nullable
max_spliceai_max_scorenumber nullable
min_plinumber nullable
max_plinumber nullable
min_oe_lof_uppernumber nullable
max_oe_lof_uppernumber nullable
min_oe_lofnumber nullable
max_oe_lofnumber nullable
min_mis_znumber nullable
max_mis_znumber nullable

Response

Successful Response

sv_countsobject nullable
variantsobject[] required

List of variants

total_countinteger required

Total number of variants matching filters

pageinteger required

Current page number

page_sizeinteger required

Number of variants per page

total_pagesinteger required

Total number of pages

has_next_pageboolean required

Whether there is a next page

has_previous_pageboolean required

Whether there is a previous page

Example response

{
  "has_next_page": true,
  "has_previous_page": false,
  "page": 1,
  "page_size": 50,
  "total_count": 150,
  "total_pages": 3,
  "variants": [
    {
      "acmg_class": "P",
      "chromosome": "chr7",
      "gene_symbol": "CFTR",
      "position": 117559590,
      "priority_score": 85.3,
      "variant_idx": 42
    }
  ]
}

Changes

    • breaking

      query request parameter min_depth list-of-types was narrowed by removing types number

    • breaking

      for the query request parameter min_depth, the type of property anyOf[subschema #1]/ was specialized from number to integer

    • info

      added the new optional query request parameter acmg_criterion

    • info

      added the new optional query request parameter biotype

    • info

      added the new optional query request parameter chromosome

    • info

      added the new optional query request parameter clinvar_significance

    • info

      added the new optional query request parameter end_position

    • info

      added the new optional query request parameter genotype

    • info

      added the new optional query request parameter has_hpo

    • info

      added the new optional query request parameter inheritance_mode

    • info

      added the new optional query request parameter max_alphamissense_score

    • info

      added the new optional query request parameter max_bayesdel_addaf_score

    • info

      added the new optional query request parameter max_bayesdel_noaf_score

    • info

      added the new optional query request parameter max_dann_score

    • info

      added the new optional query request parameter max_gerp_rs

    • info

      added the new optional query request parameter max_metasvm_score

    • info

      added the new optional query request parameter max_mis_z

    • info

      added the new optional query request parameter max_mpc_score

    • info

      added the new optional query request parameter max_oe_lof

    • info

      added the new optional query request parameter max_oe_lof_upper

    • info

      added the new optional query request parameter max_phylop100way_vertebrate

    • info

      added the new optional query request parameter max_pli

    • info

      added the new optional query request parameter max_sift_score

    • info

      added the new optional query request parameter max_spliceai_max_score

    • info

      added the new optional query request parameter min_alphamissense_score

    • info

      added the new optional query request parameter min_bayesdel_addaf_score

    • info

      added the new optional query request parameter min_bayesdel_noaf_score

    • info

      added the new optional query request parameter min_dann_score

    • info

      added the new optional query request parameter min_genotype_quality

    • info

      added the new optional query request parameter min_gerp_rs

    • info

      added the new optional query request parameter min_metasvm_score

    • info

      added the new optional query request parameter min_mis_z

    • info

      added the new optional query request parameter min_mpc_score

    • info

      added the new optional query request parameter min_oe_lof

    • info

      added the new optional query request parameter min_oe_lof_upper

    • info

      added the new optional query request parameter min_phylop100way_vertebrate

    • info

      added the new optional query request parameter min_pli

    • info

      added the new optional query request parameter min_review_stars

    • info

      added the new optional query request parameter min_sift_score

    • info

      added the new optional query request parameter min_spliceai_max_score

    • info

      added the new optional query request parameter quality_status

    • info

      added the new optional query request parameter source_filter

    • info

      added the new optional query request parameter start_position

    • info

      added the new optional query request parameter variant_type