Requests

Get one request record

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.

get/v1/requests/{id}

Request

  • Base URL: https://api.spicrawl.com
  • URL: https://api.spicrawl.com/v1/requests/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:01M0FK1EP2E7FBMWAR7W10SMXW

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

Response

The record.

idstring required

Request id; the same value as the X-Request-Id header and problem request_id.

created_atstring date-time required

When the request arrived, RFC 3339 with fractional seconds, UTC.

project_idstring required

Project whose API key made the request. Always present; tells rows apart in an all_projects=true list.

enginestring

Rendering tier that served it (fetch, js or browser). Empty for requests refused before a tier was chosen.

status'success' | 'failed' | 'timeout' | 'blocked' | 'rejected' | 'cancelled' required

Terminal outcome. Only success is ever charged.

http_statusinteger

Target's HTTP status. Absent when no response was received.

error_codestring

Problem code returned to the caller, e.g. ERR::UPSTREAM::CHALLENGE. Absent on success.

error_detailstring

The problem detail sentence the caller received (may be truncated). Read it for the specific cause.

attemptsinteger

Dispatch attempts including retries. Absent when zero.

urlstring required

Target URL as requested.

url_hoststring

Target host. Absent when unknown.

bytes_ininteger

Bytes received from the target. Absent when zero.

bytes_outinteger

Bytes sent to the target. Absent when zero.

proxy_bytesinteger

Bytes carried through a proxy exit. Absent when zero.

credits_microinteger required

Credits charged in micro-credits (1 credit = 1000000). Always 0 for non-success statuses.

featuresobject

Features the request used, as recorded by the router. Free-form; absent when none.

Example response

{
  "project_id": "01M0FJZ8Q3W4B5T8J2V9K6X1RD"
}

Changes

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