Skip to content
builders.ac

Deliverability API · Alpha / unstable

Retrieve per-domain results for one check and date

GET
/checks/{check}/results
curl --request GET \
  --url 'https://api.builders.ac/api/deliverability/v1alpha1/checks/example/results?date=2026-04-15' \
  --header 'Authorization: Bearer <token>'

Public masking also applies to details and the staff-only debug query parameter is rejected. A non-healthy, non-blacklist cell has an empty domains list even when internal diagnostic findings exist. Blacklist warning and error details remain visible.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
check
required
string
/^[a-z0-9:._-]+$/

An id returned by GET /checks, including dynamic blacklist: ids.

Query Parameters

Section titled “Query Parameters”
date
required
string format: date

A date returned in GET /checks history.

sender_id
string
/^snd_[0-9a-z]{26}$/

Restrict data to one sender owned by the authenticated account.

domain_id
string
/^dom_[0-9a-z]{26}$/

Restrict data to one domain owned by the authenticated account.

Responses

Section titled “Responses”

200

Section titled “200”

Domain-level check results

Media typeapplication/json
object
check
required
object
id
required
string
label
required
string
group
required
string
kind
string
date
required
string format: date
summary
required
object
total
required
integer
warnings
required
integer
errors
required
integer
domains
required
Array<object>
object
domain_id
required
string
/^dom_[0-9a-z]{26}$/
name
required
string
sender_id
required
One of:
string
/^snd_[0-9a-z]{26}$/
sender_name
required
string | null
status
required
string
Allowed values: healthy warning error not-tested
reasons
required
Array<string>
value
required
string | null
checked_at
required
string | null format: date-time
Example
{
  "domains": [
    {
      "status": "healthy"
    }
  ]
}

401

Section titled “401”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

404

Section titled “404”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

422

Section titled “422”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

429

Section titled “429”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

500

Section titled “500”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

503

Section titled “503”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}