spicrawlspicrawlDocs
Requests

Get one request record

Returns one record by request id (the `X-Request-Id` / `request_id` you received).

Requires scope: none (any valid key)

GET
/v1/requests/{id}

Returns one record by request id (the X-Request-Id / request_id you received). Scoped to the key's organization: a record made in the key's own project needs no scope, and one made in another project of the organization needs the read scope, the same rule as all_projects=true on the list (this route takes no parameter for it). Expired, never-existed, another project's without read, and unreadable records all answer 404 ERR::REQUEST::NOT_FOUND; a malformed id answers 400.

Authorization

bearerAuth
AuthorizationBearer <token>

Authorization: Bearer <key>. Read the key from the SPICRAWL_API_KEY environment variable; never hard-code or log it. spicrawl_test_… keys can never spend live credits. Scopes: scrape, batch, sessions (granted by default), browser and read (granted deliberately). A missing scope is 403 ERR::AUTH::INSUFFICIENT_SCOPE naming the scope.

In: header

Path Parameters

id*string

Request id, as a 26-character ULID or a UUID.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/requests/01M0FK1EP2E7FBMWAR7W10SMXW"
{  "id": "string",  "created_at": "2019-08-24T14:15:22Z",  "project_id": "01M0FJZ8Q3W4B5T8J2V9K6X1RD",  "engine": "string",  "status": "success",  "http_status": 0,  "error_code": "string",  "error_detail": "string",  "attempts": 0,  "url": "string",  "url_host": "string",  "proxy": {    "source": "pool",    "endpoint_id": "string",    "provider": "string",    "requested_tier": "string",    "requested_country": "string",    "country": "string",    "sticky": true,    "reason": "caller_proxy",    "endpoints": [      "string"    ]  },  "spans": {    "admission_ms": 0,    "dispatch_ms": 0,    "worker_ms": 0,    "queue_ms": 0,    "engine_ms": 0,    "upstream_ms": 0,    "extract_ms": 0,    "total_ms": 0  },  "blocked": {    "vendor": "string",    "signal": "string",    "rule": "string"  },  "bytes_in": 0,  "bytes_out": 0,  "proxy_bytes": 0,  "credits_micro": 0,  "features": {}}