Skip to main content
GET
GET analyses instances
GET all Analyses instances. Returns a paginated list of Analyses.

Authorizations

X-API-Key
string
header
required

Query Parameters

page
integer<int32>
default:1

Page number. Defaults to 1. See Pagination for more details.

per_page
integer<int32>
default:50

Number of requested paginated records. Defaults to 50. See Pagination for more details.

sort
string | null

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

where
string | null

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

200 - application/json

OK

$uri
string
required
read-only
Pattern: ^/api/v1/analyses/[a-f0-9]{16}$
Example:

"/api/v1/analyses/0d77065796f8d173"

analysis_type
enum<string>
required
Available options:
classification,
panel,
alignment,
control,
report,
functional,
workflow,
mlst,
assembly_run
created_at
string<date-time>
required

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

job
jobs · object
required

A reference to the versioned job underlying the analysis, e.g., {"$ref": "/api/v1/jobs/d512cb556241440f"}.

sample
samples · object
required

A reference to the sample underlying the analysis, e.g., {"$ref": "/api/v1/sample/0ee172af60e84f61"}.

complete
boolean
default:false
error_msg
string | null

The error message from the analysis, if it failed.

Maximum string length: 255
job_args
Job Args · object

The arguments passed into this analysis (can be null).

success
boolean
default:false
updated_at
string<date-time> | null

Timestamp for when the object was last updated on the One Codex platform, encoded as a RFC 3339 timestamp.