Skip to content
HeaderHawk

List crashes, grouped

GET
/v1/crashes
curl --request GET \
  --url 'https://api.us.headerhawk.com/v1/crashes?limit=50' \
  --header 'Authorization: Bearer <token>'

The page crashes browsers reported, grouped by reason, page, frame and visibility, largest first, with the totals across every group. Reads reported data, so it spends the tenant’s budget too.

Every count is an estimate: crashes are sampled at ingestion at the site’s rate, so each stored report stands for 1 / its sample rate.

Window: at most 31 days, the last 31 by default; longer is 400. Grouping reads every report in the window, and each page groups them all again. Measured worst case: 19 ms reading 14,660 reports (5 MB) in 90 days.

At most the first 10,000 groups of a query can be paged through.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
siteId
string format: uuid

Only this site’s reports. Another tenant’s site, or none, is 404.

reason
string
>= 1 characters <= 128 characters

Only crashes with this reason, exactly, such as oom.

from
string format: date-time

Only reports received at or after this instant. Defaults to the start of your retention window, or where the operation bounds its window, to that many days before to. Earlier than your retention reaches is 400.

to
string format: date-time

Only reports received before this instant. Defaults to now.

limit
integer
default: 50 >= 1 <= 200

How many items a page holds.

cursor
string
>= 1 characters <= 1024 characters

The previous page’s nextCursor. Omit it for the first page.

Responses

Section titled “Responses”

200

Section titled “200”

A page of groups, and the totals

Media typeapplication/json
object
data
required
Array<object>
object
reason
required

Why the page crashed, such as oom or unresponsive.

string
page
required

The page’s URL without its query or fragment.

string
isTopLevel
required

Whether the top-level document crashed rather than a frame; null when the browser did not say.

boolean
nullable
visibilityState
required

The page’s visibility when it crashed, where the browser said.

string
browsers
required
Array<string>
stackExcerpt
required

The start of a stack a report carried. Written by a browser; untrusted text.

string
nullable
reportCount
required
integer
estimatedReportCount
required
integer
firstSeen
required
string format: date-time
lastSeen
required
string format: date-time
totals
required

Across every group in the window, not only this page’s.

object
estimatedReportCount
required
integer
reportCount
required
integer
pageCount
required
integer
groupCount
required
integer
nextCursor
required
string
nullable
Examplegenerated
{
  "data": [
    {
      "reason": "example",
      "page": "example",
      "isTopLevel": true,
      "visibilityState": "example",
      "browsers": [
        "example"
      ],
      "stackExcerpt": "example",
      "reportCount": 1,
      "estimatedReportCount": 1,
      "firstSeen": "2026-04-15T12:00:00Z",
      "lastSeen": "2026-04-15T12:00:00Z"
    }
  ],
  "totals": {
    "estimatedReportCount": 1,
    "reportCount": 1,
    "pageCount": 1,
    "groupCount": 1
  },
  "nextCursor": "example"
}

Headers

Section titled “Headers”
RateLimit-Limit
integer

The budget nearest to running out, per minute.

RateLimit-Remaining
integer

What is left of that budget this minute.

RateLimit-Reset
integer

Seconds until that budget starts again.

400

Section titled “400”

A parameter was refused, or one the operation does not take was sent. The message names it.

Media typeapplication/json
object
error
required
object
code
required

What went wrong. An open enum: treat a code you do not know by its HTTP status.

string
Allowed values: bad_request validation_error invalid_api_key plan_upgrade_required forbidden not_found rate_limited rate_limit_unavailable upstream_unavailable internal_error
message
required

For people. Branch on code.

string
requestId
required

Quote it when you write to us about this request.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

401

Section titled “401”

invalid_api_key: no key, or one that is malformed, unknown, revoked or expired. One answer for all of them.

Media typeapplication/json
object
error
required
object
code
required

What went wrong. An open enum: treat a code you do not know by its HTTP status.

string
Allowed values: bad_request validation_error invalid_api_key plan_upgrade_required forbidden not_found rate_limited rate_limit_unavailable upstream_unavailable internal_error
message
required

For people. Branch on code.

string
requestId
required

Quote it when you write to us about this request.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

403

Section titled “403”

plan_upgrade_required: the tenant’s plan does not include API access (the key works again when it does), or does not include what this operation reads.

Media typeapplication/json
object
error
required
object
code
required

What went wrong. An open enum: treat a code you do not know by its HTTP status.

string
Allowed values: bad_request validation_error invalid_api_key plan_upgrade_required forbidden not_found rate_limited rate_limit_unavailable upstream_unavailable internal_error
message
required

For people. Branch on code.

string
requestId
required

Quote it when you write to us about this request.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”

No such resource in your tenant.

Media typeapplication/json
object
error
required
object
code
required

What went wrong. An open enum: treat a code you do not know by its HTTP status.

string
Allowed values: bad_request validation_error invalid_api_key plan_upgrade_required forbidden not_found rate_limited rate_limit_unavailable upstream_unavailable internal_error
message
required

For people. Branch on code.

string
requestId
required

Quote it when you write to us about this request.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

429

Section titled “429”

rate_limited: over a budget. Wait Retry-After seconds.

Media typeapplication/json
object
error
required
object
code
required

What went wrong. An open enum: treat a code you do not know by its HTTP status.

string
Allowed values: bad_request validation_error invalid_api_key plan_upgrade_required forbidden not_found rate_limited rate_limit_unavailable upstream_unavailable internal_error
message
required

For people. Branch on code.

string
requestId
required

Quote it when you write to us about this request.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before trying again.

503

Section titled “503”

rate_limit_unavailable or upstream_unavailable: HeaderHawk could not serve this now. Nothing is wrong with the request; try again after Retry-After seconds.

Media typeapplication/json
object
error
required
object
code
required

What went wrong. An open enum: treat a code you do not know by its HTTP status.

string
Allowed values: bad_request validation_error invalid_api_key plan_upgrade_required forbidden not_found rate_limited rate_limit_unavailable upstream_unavailable internal_error
message
required

For people. Branch on code.

string
requestId
required

Quote it when you write to us about this request.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before trying again.