Search archive metadata

Common SPA/M2M exact-count cursor contract. Snapshot PIT extends 5 minutes up to 30 minutes total; live is explicit. Security uncertainty returns 503 without count or partial hits.

POST/api/archive/search

Search archive metadata

curl --request POST \
  --url 'https://app.output.rocks/api/archive/search' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cursor": "string",
  "filters": {},
  "options": {
    "mode": "snapshot",
    "pageSize": 1,
    "sortBy": "id",
    "sortDirection": "ASC"
  }
}'

200

application/json

{
  "hydra:member": [
    {}
  ],
  "hydra:totalItems": 1,
  "nextCursor": "string",
  "previousCursor": "string",
  "searchSessionId": "123e4567-e89b-12d3-a456-426614174000",
  "searchAsOf": "2024-08-23T00:00:00+00:00",
  "consistencyMode": "snapshot"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json

required

{
  "cursor": "string",
  "filters": {},
  "options": {
    "mode": "snapshot",
    "pageSize": 1,
    "sortBy": "id",
    "sortDirection": "ASC"
  }
}

Response

200application/json

Successful response

hydra:member

object[]

hydra:totalItems

integer

Exact authorized count.

nextCursor

string | null

previousCursor

string | null

searchSessionId

string<uuid>

searchAsOf

string<date-time>

consistencyMode

enum<string>

Available options: snapshotlive