variants

Query variants

Query processed variants with filters and pagination

get/sessions/{session_id}/variants

Request

  • Base URL: https://api.helena.bio (the document declares no server; this is the origin it was published from)
  • URL: https://api.helena.bio/sessions/{session_id}/variants
  • Auth: none declared

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

Consequences

impactstring[] nullable

Impact levels

max_gnomad_afnumber nullable
include_unknown_afboolean
min_depthnumber 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)

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

No recorded changes to this operation across all 1 revision of this API.