Get analysis details

/api/v1/analysis

Gets the analysis details and links to download a Quality Control (QC) report, final report, and compressed archive (ZIP format) of unfiltered and filtered variants files. Returns a JSON object that contains the download information.

GET

• format

  String, Optional.

  Response type, current version supports only json.

• type.

  String. Optional.

  Valid values are "sample" or "analysis".

  If the type parameter is not provided, "analysis" is used as the default value.

• name

  String. Mandatory.

  Name of sample or analysis.

• id

  String. Optional.

  Id of an analysis. If type is sample, this corresponds to the sample id.

• start_date

  String. Optional.

  Parameter to filter the results by date boundary. Use date format: yyyy-MM-dd.

• end_date.

  String. Optional.

  Parameter to filter the results by date boundary. Use date format: yyyy-MM-dd.

• duration.

  String. Optional.

  Parameter to filter the results by days/months Valid value starts with "-" followed by numeric value and ends with "d" or "m".

• exclude

  String. Optional.

  Parameter to filter the response. Valid values are any single or comma-separated combination of values "reports, unfilteredvariants, filteredvariants".

• view

  String. Optional.

  Valid values are "summary" or "." If the value is empty, reports are not generated.

https://user1.XYZ.com/api/v1/analysis?format=json&name=xyzsampletest
&exclude=reports,filteredvariants,unfilteredvariants&start_date=2016-01-01
&end_date=2016-02-01

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

Authorization:API Token

[

  {
    "reports": {
      "qc": {
        "link": "http://user1.XYZ.com/api/v1/download?type=pdf&
                filePath=/data/IR/data/IR_Org/download/pdf/
                30cf8ff3-fe3d-4cac-8f7d-ce45aa7d34e1/
                    ff80818153ed40a401540716785a081a_QC.pdf"
      },
      "final": {}
    },
    "report_published": "",
    "workflow": "Annotate variants single sample",
    "data_links": {
      "filtered_variants": "http://user1.XYZ.com/api/v1/download?    
                            filePath=/data/IR/data/IR_Org/user1.XYZ.com/
                            Demo_AmpliSeq_Exome_VCF/
                            Demo_AmpliSeq_Exome_VCF_20160411134952720/
                            Demo_AmpliSeq_Exome_VCF_1460407585676.zip",
      "unfiltered_variants": "http://user1.XYZ.com/api/v1/download?
                            filePath=/data/IR/data/IR_Org/user1.XYZ.com/
                            Demo_AmpliSeq_Exome_VCF/
                            Demo_AmpliSeq_Exome_VCF_20160411134952720/
                            Demo_AmpliSeq_Exome_VCF_1460407585676.zip"
    },
    "variants_saved": "",
    "samples": {
      "PROBAND": "Demo AmpliSeq Exome VCF"
    },
    "shared_with": [],
    "stage": "Review Variants"
    "flagged": false,
    "name": "Demo AmpliSeq Exome VCF_1460407585676",
    "id": "ff80818153ed40a401540716785a081a",
    "ion_reporter_version": "5.22",
    "started_by": "User1",
    "start_date": "April 11, 2025",
    "status": "SUCCESSFUL"
  }
]

200

Successful response

400

Bad request

404

Not found

401

User is not authenticated

500

Error occurred