RunService

ListRuns

List runs accessible to the authenticated tenant, optionally filtered.

get/v1/runs

Request

Base URL: https://cloud-api.usw2.elembio.io
URL: https://cloud-api.usw2.elembio.io/v1/runs
Auth: API key in header x-api-key

Query parameters

filterstring

Search and filter expression. Space-separated keyword:value terms are ANDed together; bare text with no keyword searches all string fields. For numeric and date fields, replace the colon with a comparison operator (>=, <=, >, <, !=). List alternatives for one keyword with commas, e.g. status:completed,failed. Dates accept ISO-8601 or relative offsets such as 7d or 1mo.

Filterable keywords:

String: name, id, description, tags, instrument.name, instrument.serial_number, instrument.model, storage.connection_id, setup.sequencing.kit_name, setup.sequencing.library_structure, setup.sequencing.prep_type, setup.sequencing.polony_density, setup.sequencing.filter_mask, setup.sequencing.panel.name, setup.multiomics.panel.name, setup.multiomics.cartridge.name
Enum: type (sequencing, multiomics), status, output.kind (sequencing_run, multiomics_run; an alias for type), setup.multiomics.kit_type (cytoprofiling, direct_in_sample_sequencing, antibody_screening, tissue, protein_screening), setup.multiomics.well_layout (twelve_well_circle, twelve_well_square, two_well, one_well, twelve_well_standard, forty_eight_well)
Date: time_created, time_started, time_completed, time_updated
Numeric: metrics.sequencing.total_reads, metrics.sequencing.total_yield, metrics.sequencing.estimated_reads, metrics.sequencing.q30, metrics.sequencing.q40, metrics.sequencing.q50, metrics.sequencing.avg_q, metrics.sequencing.error_rate, metrics.sequencing.phix_alignment_rate, metrics.multiomics.total_cell_count, metrics.multiomics.total_cell_confluency, metrics.multiomics.total_percent_assigned, setup.sequencing.pmg_shift
Boolean: setup.sequencing.low_diversity

Examples:

type:sequencing status:completed time_completed>=7d
instrument.serial_number:AV223501 metrics.sequencing.q30>=90

pageSizeinteger

Maximum number of runs to return (default: 100, max: 1000)

pageTokenstring

Token for pagination

includeTotalCountboolean

If true, include total_count in the response (adds a count query)

Response

Success

nextPageTokenstring

Token for the next page (empty if no more results)

previousPageTokenstring

Token for the previous page (empty if on first page)

totalCountinteger nullable

Total number of runs matching the filter (only if include_total_count was true)

Example response

{
  "runs": [
    {
      "timeCreated": "2023-01-15T01:30:15.01Z",
      "timeStarted": "2023-01-15T01:30:15.01Z",
      "timeCompleted": "2023-01-15T01:30:15.01Z",
      "timeUpdated": "2023-01-15T01:30:15.01Z",
      "manifest": {
        "timeUploaded": "2023-01-15T01:30:15.01Z"
      },
      "setup": {
        "sequencing": {
          "flowcell": {
            "expiration": "2023-01-15T01:30:15.01Z"
          },
          "buffer": {
            "expiration": "2023-01-15T01:30:15.01Z"
          },
          "sequencingCartridge": {
            "expiration": "2023-01-15T01:30:15.01Z"
          }
        },
        "multiomics": {
          "flowcell": {
            "expiration": "2023-01-15T01:30:15.01Z"
          },
          "buffer": {
            "expiration": "2023-01-15T01:30:15.01Z"
          },
          "panelCartridge": {
            "expiration": "2023-01-15T01:30:15.01Z"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.