Retrieve summary statistics

GET

/discovery/query

curl --request GET \
  --url 'https://your-candig-domain/query/discovery/query?treatment=Bone%20marrow%20transplant%7CChemotherapy&primary_site=Adrenal%20gland%7CBladder&drug_name=FLUOROURACIL%7CLEUCOVORIN&gene=ZYG11A&assembly=hg38&exclude_programs=SYNTHETIC-1&genomic_data_types=genomes%7Cvariants'

Retrieve summary statistics on the metadata for each program that match the given query parameters.

Authorizations

• None
• BasicAuth
• BearerAuth

Parameters

Query Parameters

treatment

Acceptable requested fields for querying

Array<string>

A pipe-separated list of treatments to look for

Example

Bone marrow transplant|Chemotherapy

primary_site

Acceptable requested fields for querying

Array<string>

A pipe-separated list of affected primary sites to look for

Example

Adrenal gland|Bladder

drug_name

Acceptable requested fields for querying

Array<string>

A pipe-separated list of drug names to look for

Example

FLUOROURACIL|LEUCOVORIN

chrom

Acceptable requested string for querying

string

A chromosome to search for variants within. This cannot be used with a geneParam, and must be of the format chr#:start-end

gene

Acceptable requested fields for querying

Array<string>

A gene name to search for variants within. This cannot be used with chrParam

Example

ZYG11A

assembly

Acceptable requested string for querying

string

A genomic assembly to search for variants within.

Example

hg38

exclude_programs

Acceptable requested fields for querying

Array<string>

A list of programs that will be excluded from results

Example

SYNTHETIC-1

genomic_data_types

Acceptable requested fields for querying

Array<string>

A list of genomic data types to include in the query. If value includes ‘any’, return any genomic data type.

Example

genomes|variants

Responses

200

Summary statistics

Media typeapplication/json

Discovery programs

object

site

Whole-site summary statistics

object

programs

Per-program summary statistics

array

Example^generated

{
  "site": {},
  "programs": [
    "example"
  ]
}

5XX

Unspecified server error encountered

Media typeapplication/json

object

query

required

Error object container

object

error

required

Name/type of the error that occurred

string

message

required

Message explaining why the error occurred

string

Example

{
  "query": {
    "error": "ServerError",
    "message": "An unspecified server error occurred"
  }
}