Skip to main content
GET
/
api
/
v1
/
analyses
/
{id}
GET analyses
curl --request GET \
  --url https://app.onecodex.com/api/v1/analyses/{id} \
  --header 'X-API-Key: <api-key>'
{
  "$uri": "<string>",
  "analysis_type": "<string>",
  "complete": true,
  "created_at": "2023-11-07T05:31:56Z",
  "error_msg": "<string>",
  "job": {
    "type": "<unknown>"
  },
  "job_args": {},
  "sample": {
    "type": "<unknown>"
  },
  "success": true,
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

GET a single analysis by its ID.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

Response

200 - application/json

Successful operation

​
$uri
string
​
analysis_type
string

The type of analysis performed. Currently supported analysis types on the One Codex platform are: classification, panel, and alignment.

​
complete
boolean

If the analysis is complete. Incomplete or pending analyses will show a icon in the One Codex web application.

​
created_at
string<date-time>
​
error_msg
string

An error message if the analysis failed. Should generally be `` or null if the analysis succeeded or is pending.

​
job
object
​
job_args
object
​
sample
object
​
success
boolean

true if the analysis was successful.

​
updated_at
string<date-time>