Read a spam-history check

The state of a history check. Poll after `poll_after_ms` until `status` is `ready` (with `result`) or `failed` (with `error`: `archive_unavailable`, `model_unavailable`, `timeout` or `internal`). Reading costs no history budget. The `result` is a verdict (`clean`, `content_changed_hands`, `spam_history`, `restricted_history`, `no_history` or `inconclusive`) with its reasons and caveats, the coverage of the archive sample, a per-year timeline with an archive replay link for each captured year, and the flips between years. Report the caveats with the verdict. A label the service does not recognise arrives as `unknown`. The id belongs to the account that started the check. Another account's id, an unknown id and an expired id are all the same 404.

GET/api/v1/history/{id}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

idstringrequired

The `id` from `POST /history`.

Responses

The check.

domainstringrequired

errorenum

Available options: archive_unavailable, model_unavailable, timeout, internal, unknown

idstringrequired

poll_after_msany

resultany

Present when `status` is `ready`: `domain`, `checked_at`, `verdict` {`code`, `summary`, `reasons`, `caveats`}, `coverage` {`capture_years`, `first_year`, `last_year`, `pages_sampled`, `pages_cap`}, `timeline` [{`year`, `captured_at`, `archive_url`, `state`, `spam_signal`, `restricted`, `kinds`, `topics`, `confidence`}], `flips` [{`type`, `from_year`, `to_year`}] and `model` {`name`, `version`}.

status"queued" | "running" | "ready" | "failed"required

Available options: queued, running, ready, failed

curl --request GET \
  --url "https://getrevised.com/api/v1/history/ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://getrevised.com/api/v1/history/ID", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  },
});
const data = await res.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

r = requests.get("https://getrevised.com/api/v1/history/ID", headers=headers)
r.raise_for_status()
data = r.json()

{
  "domain": "<string>",
  "error": "archive_unavailable",
  "id": "<string>",
  "poll_after_ms": {},
  "result": {},
  "status": "queued"
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}