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"
    }
  ]
}

Changes

Changed in 6 of the 26 revisions of this API.241

    • added the new WEBSITE_BLOCKED enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new WEBSITE_BLOCKED enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new CONTENT_TOO_LARGE enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new CONTENT_TOO_LARGE enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new PDF_IMAGES_ONLY enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new PDF_IMAGES_ONLY enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new PDF_SKIPPED enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new PDF_SKIPPED enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new WEBSITE_NOT_FOUND enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new WEBSITE_NOT_FOUND enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new BATCH_LIMIT_EXCEEDED enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new BATCH_LIMIT_EXCEEDED enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new BATCH_NOT_CANCELLABLE enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new BATCH_NOT_CANCELLABLE enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new BATCH_NOT_COMPLETED enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new BATCH_NOT_COMPLETED enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new IDEMPOTENCY_KEY_CONFLICT enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new IDEMPOTENCY_KEY_CONFLICT enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new MONITOR_NO_WEBHOOK enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new MONITOR_NO_WEBHOOK enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • added the new PAID_PLAN_REQUIRED enum value to the error_code response property for the response status 401

      response-property-enum-value-added

    • added the new PAID_PLAN_REQUIRED enum value to the error_code response property for the response status 404

      response-property-enum-value-added

    • endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog