Data Hub
Runs

List a run's report items

Requires scope `files:read`. Returns `{id, filename}` for the run's renderable images, PDFs, spectra, or videos, ordered by filename. Paged with `offset`/`limit` so viewers can seek by item index.

GET
/instruments/{instrumentId}/runs/{runId}/report-items

Requires scope files:read. Returns {id, filename} for the run's renderable images, PDFs, spectra, or videos, ordered by filename. Paged with offset/limit so viewers can seek by item index.

Authorization

bearerAuth
AuthorizationBearer <token>

Personal access tokens begin with dhub_… and are restricted by their assigned scopes.

In: header

Path Parameters

instrumentId*string
runId*string

The run ID. Spaces at the start or end are ignored.

Query Parameters

kind*string

Which renderable artifacts to list. media lists videos and images together, and leaves out an image whose video has the same name, because that image is the video's poster.

Value in

  • "image"
  • "media"
  • "pdf"
  • "spectrum"
  • "video"
search?string

Case-insensitive filename substring filter.

offset?|
Range0 <= value
limit?integer
Range1 <= value <= 200
anchor?integer

File id to centre the window on. Overrides offset and returns the item's position as anchor_index.

Range0 < value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/instruments/plate-reader/runs/run-2026-001/report-items?kind=image"
{  "data": [    {      "id": 0,      "filename": "string",      "poster_id": 0    }  ],  "pagination": {    "offset": 0,    "limit": 0,    "total": 0,    "anchor_index": 0  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

Cancel a run's queued files POST

Requires scope `runs:reprocess`. Takes every `queued` file of the run out of the reprocessing queue. Each one becomes `failed` with a message that says the reprocess was cancelled, and can be reprocessed again. Files that have already started are not affected. Works on a soft-deleted run too. `files_cancelled` is 0 when no file was queued.

Search Data Hub GET

Requires scope `runs:read`.