Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/GET /v1/jobs/{jobId}/qc/metrics

    GET /v1/jobs/{jobId}/qc/metrics

    Read a job's plate QC metrics

    Auth: required. Send an 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

    jobIdstring (uuid)

    Job UUID.

    Query parameters

    minControlsnumber

    Minimum number of values in each of the low and high groups used for Z'

    tailFractionnumber

    Fraction of the values taken from each end as the low and high groups

    Responses

    200 OK

    The QC metrics

    Response shape:

    successenum (true)
    zPrimenumber

    Heuristic Z' factor, or null when it cannot be computed.

    cvByRowobject

    Coefficient of variation per plate row, keyed by row number.

    cvByColobject

    Coefficient of variation per plate column, keyed by column number.

    shapeobject

    400 Bad Request

    The job id is missing

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    403 Forbidden

    You cannot read the job, or it is outside your API key's project scope. This route answers 403 here, not 404; code is UNAUTHORIZED and message is Forbidden.

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    500 Internal Server Error

    Computing the metrics failed

    Response shape: object

    curl -X GET 'https://ivybiosciences.com/api/v1/jobs/{jobId}/qc/metrics' \
      -H "Authorization: Bearer $IVY_API_KEY"

    Was this page helpful?

    Loading...