Requests

List recent requests in the key's project, or in every project of its organization

Per-request records from the ephemeral request log, newest first, for the API key's project (every key in that project, not only this key). With all_projects=true and a key carrying the read scope, the records of every project in the key's organization (archived projects included), merged into one newest-first list under the same cursor. Every record carries project_id. Records expire after page.retention_hours; for durable billing totals use GET /v1/usage. Totals here will not match an invoice.

Pitfalls:

  • Page with BOTH before and before_id copied from page.next_before / page.next_before_id. before alone re-returns the boundary record and cannot break same-millisecond ties; before_id alone does not bound the page at all.
  • A cursor older than the retention window returns 410 ERR::REQUEST::BEYOND_RETENTION. Restart from the first page.
  • An empty data means "nothing in the last retention_hours", not "never". Check retained_since.
  • A page can be shorter than limit while has_more is true. Keep paging until has_more is false.
  • limit is clamped silently: missing, non-numeric or non-positive gives 50, above 200 gives 200.
  • all_projects=true without the read scope is 403 ERR::AUTH::INSUFFICIENT_SCOPE, naming read. The default list needs no scope beyond a valid key. The organization is always the key's own; no parameter names another.
  • Keep all_projects=true on every page of one walk: the cursor pages whichever list it came from.
get/v1/requests

Request

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

Query parameters

all_projects'true' | 'false'

When true, lists every project in the key's organization instead of only the key's project. Requires the read scope (403 ERR::AUTH::INSUFFICIENT_SCOPE without it). Only true and false are accepted; any other value is 400.

limitinteger

Page size. Never refused; invalid values fall back to 50 and values above 200 become 200.

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

Only records with exactly this status. Not validated; an unknown value returns an empty page. Ignored when only_errors=true.

only_errors'true' | 'false'

When exactly true, returns every record whose status is not success. Any other value (including 1) is treated as false.

beforestring date-time

Cursor time, RFC 3339 with optional fractional seconds, copied from page.next_before. Must be sent together with before_id.

before_idstring
Example:01M0FK1EP2E7FBMWAR7W10SMXW

Cursor id, copied from page.next_before_id. Must be sent together with before.

Response

One page of request records plus the retention facts needed to interpret it.

Example response

{
  "data": [
    {
      "project_id": "01M0FJZ8Q3W4B5T8J2V9K6X1RD"
    }
  ]
}

Changes

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