Get QC report

qcreport

URL

/api/v1/qcreport

Description

Gets the Quality Control (QC) Report. Returns a JSON object that contains download information.

Method

GET

Request query parameters

  • format.

    String. Optional.

    Response type, current version supports only json.

  • type

    String, Optional.

    Valid values are "sample" or "analysis".

  • name

    String, Conditional.

    If type parameter is "sample" then name is Mandatory.

  • id.

    String, Optional.

    Id of an Analysis.

  • start_date.

    String, Optional.

    Parameter to filter the results by date boundary. Date format should be in yyyy-MM-dd format.

  • end_date

    String, Optional.

    Parameter to filter the results by date boundary. Date format should be in yyyy-MM-dd. format.

  • view

    String,Optional.

    Valid values are "summary" or "" .

Example request

https://ionreporter.thermofisher.com/api/v1/qcreport?fomat=json&type=analysis&
name=Demo AmpliSeq Exome VCF_1460407585676&start_date=2016-01-30&end_date=2016-04-12

Request headers

Content-Type:application/x-www-form-urlencoded

Authorization:API Token

Returns


[
  {
    "stage": "VARIANT_REVIEW",
    "flagged": false,
    "name": "Demo AmpliSeq Exome VCF_1460407585676",
    "id": "ff80818153ed40a401540716785a081a",
    "qc_metrics": {
      "Demo AmpliSeq Exome VCF": {
        "Number of Heterozygous SNVs": " 32451",
        "CNV/Total": " 0.000",
        "Number of Homozygous INDELs": " 1089",
        "Ti/Tv Ratio (SNPs)": " 2.308",
        "MAPD": "N/A",
        "LongDels/Total": " 0.000",
        "Number of Heterozygous INDELs": " 2113",
        "Heterozygotes/Homozygotes": " 1.737",
        "Indels/kb": " 0.001",
        "Number of Heterozygous MNVs": " 0",
        "Number of LongDels": " 0",
        "Number of Homozygous MNVs": " 0",
        "Indels/Total": " 0.059",
        "SNPs/kb": " 0.017",
        "Number of Homozygous SNVs": " 18814",
        "Number of CNVs": " 0",
        "dbSNP concordance": " 0.934"
      }
    },
    "started_by": "Ion User",
    "ion_reporter_version": "5.2",
    "samples": {
      "PROBAND": "Demo AmpliSeq Exome VCF"
    },
    "qc_report_pdf": "http://ionreporter.thermofisher.com/api/v1/download?type=pdf&
                filePath=/data/IR/data/IR_Org/download/pdf/
                890e4268-46dc-442b-a4ed-aa87bb28f71a/
                ff80818153ed40a401540716785a081a_QC.pdf",
    "start_date": "2016-04-11 13:49:53.0",
    "status": "SUCCESSFUL",
    "qc_package": "http://ionreporter.thermofisher.com/api/v1/download?
                filePath=/data/IR/data/IR_Org/ion.reporter@lifetech.com/
                Demo_AmpliSeq_Exome_VCF/Demo_AmpliSeq_Exome_VCF_20160411134952720/
                analysis_downloads/QC_Bundle/
                qc-report-Demo_AmpliSeq_Exome_VCF_1460407585676_2016-04-12 04-33.zip"
  }
]

Response fields

Status code

Response message

200

Successful response

400

Bad request

404

Not found

401

User is not authenticated

500

Error occurred

Curl command

curl -v -k -X GET "https://<your server name>/api/v1/qcreport?format=json&name=BRCA_Plus_RR_jul29&type=analysis&start_date=2016-07-25&end_date=2016-07-31" -H "Content-Type:application/x-www-form-urlencoded" -H "Authorization:NDliYmU0OWE4MzA3YmE2MWVmMjhlZTlhOTEyMmE5ODM0NzU3NjQ4OGM5NzVjODU3YjdlMWM4Mjk3OGYzODE4Yw"