GET /v1/jobs/{jobId}/qc/metrics
Read a job's plate QC metrics
ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.Computes QC metrics from the readout rows of a job you can read: the coefficient of variation per plate row and per plate column, an estimated Z' factor and the plate shape.
The Z' factor is a heuristic. The route has no control labels, so it treats the lowest and highest readout values as the negative and positive controls. It is null when there are too few values or the two group means are equal. shape is the largest row and column seen in the well names, defaulting to a standard plate when none can be parsed. The X-Metrics-Rows header gives the number of readout rows used and X-Metrics-HasZPrime says whether zPrime is set.
Request
Path parameters
Job UUID.
Query parameters
Minimum number of values in each of the low and high groups used for Z'
Fraction of the values taken from each end as the low and high groups
Responses
200 OK
Response shape:
Heuristic Z' factor, or null when it cannot be computed.
Coefficient of variation per plate row, keyed by row number.
Coefficient of variation per plate column, keyed by column number.
400 Bad Request
Response shape: object
401 Unauthorized
Response shape: object
403 Forbidden
code is UNAUTHORIZED and message is Forbidden.Response shape: object
429 Too Many Requests
Response shape: object
500 Internal Server Error
Response shape: object
Was this page helpful?