Get run history

GET

/v1/sites/{id}/history

const url = 'https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/history?limit=90';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/history?limit=90' \
  --header 'x-api-key: <x-api-key>'

Per-run trend metrics for completed runs, ordered oldest → newest — ready to chart. Two series on independent clocks: runs (crawl runs — broken links over time) and a11yRuns (runs that scanned accessibility — the score over time).

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Path Parameters

required

string format: uuid

The site’s UUID.

Query Parameters

limit

integer

default: 90 >= 1 <= 365

Maximum number of runs per series. Defaults to 90, capped at 365.

Responses

200

Completed runs, oldest first, per series.

application/json

object

runs

required

Array<object>

A single crawl run and its summary metrics.

object

required

string format: uuid

tenant_id

required

string

site_id

required

string format: uuid

started_at

required

Epoch ms the run started.

integer

finished_at

required

Epoch ms the run finished, or null while running.

integer | null

state

required

string

Allowed values: running completed failed

pages_crawled

required

integer

links_checked

required

integer

broken_count

required

Distinct broken link targets found in the run.

integer

pages_with_broken_count

required

Distinct source pages that had at least one broken link.

integer

internal_broken

required

integer

external_broken

required

integer

a11y_score

required

Synthesized 0–100 accessibility score, or null when the run didn’t scan.

integer | null

<= 100

a11y_critical

required

Confirmed violations with critical impact.

integer

a11y_serious

required

integer

a11y_moderate

required

integer

a11y_minor

required

integer

a11y_pages_scanned

required

Internal pages the accessibility scan covered in this run.

integer

a11y_issue_count

required

Distinct confirmed (page, rule) accessibility violations this run (0 for crawl runs).

integer

a11y_resolved

required

Violations present in the previous accessibility run but gone in this one (the “fixed” trend).

integer

seo_score

Synthesized 0-100 SEO score, or null when the run didn’t extract SEO data.

integer | null

<= 100

seo_critical

integer

seo_serious

integer

seo_moderate

integer

seo_minor

integer

seo_pages_scanned

Pages an SEO snapshot was captured for (at most pages_crawled).

integer

seo_issue_count

Derived SEO issues at the time the run finalized.

integer

error

required

Failure reason if state is failed, otherwise null.

string | null

kind

required

crawl for a broken-link crawl, a11y for a standalone accessibility scan.

string

Allowed values: crawl a11y

a11yRuns

required

Array<object>

A single crawl run and its summary metrics.

object

required

string format: uuid

tenant_id

required

string

site_id

required

string format: uuid

started_at

required

Epoch ms the run started.

integer

finished_at

required

Epoch ms the run finished, or null while running.

integer | null

state

required

string

Allowed values: running completed failed

pages_crawled

required

integer

links_checked

required

integer

broken_count

required

Distinct broken link targets found in the run.

integer

pages_with_broken_count

required

Distinct source pages that had at least one broken link.

integer

internal_broken

required

integer

external_broken

required

integer

a11y_score

required

Synthesized 0–100 accessibility score, or null when the run didn’t scan.

integer | null

<= 100

a11y_critical

required

Confirmed violations with critical impact.

integer

a11y_serious

required

integer

a11y_moderate

required

integer

a11y_minor

required

integer

a11y_pages_scanned

required

Internal pages the accessibility scan covered in this run.

integer

a11y_issue_count

required

Distinct confirmed (page, rule) accessibility violations this run (0 for crawl runs).

integer

a11y_resolved

required

Violations present in the previous accessibility run but gone in this one (the “fixed” trend).

integer

seo_score

Synthesized 0-100 SEO score, or null when the run didn’t extract SEO data.

integer | null

<= 100

seo_critical

integer

seo_serious

integer

seo_moderate

integer

seo_minor

integer

seo_pages_scanned

Pages an SEO snapshot was captured for (at most pages_crawled).

integer

seo_issue_count

Derived SEO issues at the time the run finalized.

integer

error

required

Failure reason if state is failed, otherwise null.

string | null

kind

required

crawl for a broken-link crawl, a11y for a standalone accessibility scan.

string

Allowed values: crawl a11y

Example

{
  "runs": [
    {
      "state": "running",
      "kind": "crawl"
    }
  ],
  "a11yRuns": [
    {
      "state": "running",
      "kind": "crawl"
    }
  ]
}

401

Missing or invalid credentials.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "invalid api key"
}

404

No site with that id is visible to the caller.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "site not found"
}