variants

Get variants grouped by gene

Returns variants aggregated by gene with summary statistics

get/sessions/{session_id}/variants/by-gene

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/by-gene
  • Auth: none declared

Path parameters

session_idstring uuid required

Query parameters

acmg_classstring[] nullable

Filter by ACMG classifications

impactstring[] nullable

Filter by impact levels

gene_symbolstring nullable

Filter by gene symbol (partial match)

pageinteger nullable

Page number (optional, returns all if not provided)

page_sizeinteger nullable

Genes per page (optional)

Response

Successful Response

total_genesinteger required

Total number of genes

total_variantsinteger required

Total number of variants across all genes

pageinteger required

Current page number

page_sizeinteger required

Genes 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

{
  "genes": [
    {
      "benign_count": 0,
      "best_acmg_class": "P",
      "best_acmg_priority": 1,
      "best_impact": "HIGH",
      "best_priority_score": 92.5,
      "gene_symbol": "BRCA1",
      "likely_benign_count": 0,
      "likely_pathogenic_count": 1,
      "pathogenic_count": 2,
      "variant_count": 5,
      "variants": [],
      "vus_count": 2
    }
  ],
  "has_next_page": true,
  "has_previous_page": false,
  "page": 1,
  "page_size": 50,
  "total_genes": 150,
  "total_pages": 3,
  "total_variants": 5000
}

Changes

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