GetSampleMetricsFileUrl

Geneyx now supports the ability to download the QcMetrics files of a given sample that was processed from the secondary implemented within Geneyx. The files are accessible using the following API infrastructure. This API will provide a URL that will enable download of the requested file. It is important to note that this functionality is subject to fees associated with bandwidth consumption, and should be discussed with your sales representative.

URL:

https://analysis.geneyx.com/api/GetSampleMetricsFileUrl

Action:

POST

Payload:

JSON Structure

Requirements:

Category	Parameter	Description	Required
Auth	apiUserId	The API user Id	Yes
	apiUserKey	The API user key	Yes
Sample	sampleSn	Same as the name given to the VCF file (SampleSerialNumber, sampleId)	Yes

Output Metrics

The mapping_metrics information can be found here: https://support.illumina.com/help/DRAGEN_Germline_Pipeline_v337_OLH_1000000083701/content/source/informatics/apps/mapalignmetrics_swbs_appdraggp.htm

The vc_metrics information can be found here: https://support.illumina.com/help/DRAGEN_Germline_Pipeline_v337_OLH_1000000083701/content/source/informatics/dragen/softwarevarcal_appdrag.htm

Request

{
  "apiUserId": "enter api user ID"
  "apiUserKey": "enter api user key",
  "sampleSn": "10230396_S29_L001.dragen.wes.grch37.20230811-162804",
}

Response

{ “Code”: “success”, “Data”: “https://geneyx-qa-primary-pipeline.s3.eu-west-1.amazonaws.com/538efde3-f70a-4dea-b29b-b7ee2e90f98e/sample/735722b5-fc20-431a-9177-0dc6c94c065d/CS-2110b1.dragen.wes.hg38.20231005-061505.qc-metrics.zip?X-Amz-Expires=600&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA35QEDO2NUPRVDV3X/20231005/eu-west-1/s3/aws4_request&X-Amz-Date=20231005T165937Z&X-Amz-SignedHeaders=host&X-Amz-Signature=911f0d681ae70af45a89c1f07f92f699a9aa7790a7164f4432191a7051294a14”, “Info”: null, “MoreInfo”: null, “NeedEval”: false }

GetSampleMetricsFileUrl - geneyx/geneyx.analysis.api GitHub Wiki