Sign in

v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB
webdbs

Get a run

Returns the status and results of one collection run.

get/webdbs/runs/{run_id}

Path parameters

run_idstring required

Run ID.

Example:run_123

Run ID.

Query parameters

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Run

idstring required

Run ID.

collection_idstring required

Collection ID.

status'queued' | 'running' | 'completed' | 'partial' | 'failed' | 'skipped' required

Current run status.

trigger'initial' | 'scheduled' | 'manual' | 'reprocess' | 'purge' required

Action that started the run.

capped_url_countinteger required

URLs skipped because a credit limit was reached.

skip_reason'insufficient_credits' | 'collection_paused' | 'superseded' | 'null' nullable required

Why a skipped run did not start.

started_atstring date-time nullable required

Time the run started.

completed_atstring date-time nullable required

Time the run finished.

created_atstring date-time required

Time the run was created.

Example response

{
  "id": "run_123",
  "collection_id": "col_123",
  "by_target": [
    {
      "target_id": "tgt_123"
    }
  ]
}