The report types with reports

GET

/v1/reports/types

const url = 'https://api.us.headerhawk.com/v1/reports/types';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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.us.headerhawk.com/v1/reports/types \
  --header 'Authorization: Bearer <token>'

Each report type with reports in the window, and how many. CSP violations are always listed, even with none; another type only when it has some. Reads reported data, so it spends the tenant’s budget too.

Window: the last 7 days by default, as the list’s; at most 31, longer is 400. Measured worst case: 36 ms for 126,148 reports of every type (13 MB) in 90 days.

Authorizations

apiKey

Parameters

Query Parameters

siteId

string format: uuid

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

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.

string format: date-time

Only reports received before this instant. Defaults to now.

Responses

200

The types

application/json

object

data

required

Array<object>

object

reportType

required

Every type of report HeaderHawk stores and lists. The issue types (IssueReportType) and deprecation, intervention, network-error and crash. An open enum.

string

Allowed values: csp-violation integrity-violation coep coop permissions-policy-violation document-policy-violation connection-allowlist deprecation intervention network-error crash

estimatedReportCount

required

Reports in the window, scaled up for sampling.

integer

sampled

required

boolean

Example

{
  "data": [
    {
      "reportType": "csp-violation"
    }
  ]
}

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

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

application/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

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

application/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

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.

application/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

No such resource in your tenant.

application/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

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

application/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

Retry-After

integer

Seconds to wait before trying again.

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.

application/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

Retry-After

integer

Seconds to wait before trying again.