Skip to content
builders.ac

Deliverability API · Alpha / unstable

Retrieve message volumes grouped by mailbox provider

GET
/esp-distribution
curl --request GET \
  --url 'https://api.builders.ac/api/deliverability/v1alpha1/esp-distribution?range=1h&metrics%5B%5D=sent' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
range
string
default: 7d
Allowed values: 1h 8h 24h 3d 7d 14d

Time window. Defaults to 7d.

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.

metrics[]
Array<string>
default: sent >= 1 items <= 8 items
Allowed values: sent received outreach warmup reply autoresponse other system

One or more metrics. Repeat this bracketed parameter for multiple values. Defaults to sent.

Responses

Section titled “Responses”

200

Section titled “200”

ESP distribution

Media typeapplication/json
object
metrics
required
object
key
additional properties
object
microsoft
required
integer
google
required
integer
others
required
integer
gated
required
boolean
availability
required
object
key
additional properties
boolean
coverage
required
object
ratio
required
number | null
threshold
required
number | null
agent
required
integer
trace
required
integer
meta
required
object
range
string
default: 7d
Allowed values: 1h 8h 24h 3d 7d 14d
granularity
string
Allowed values: hour day
classification_since
string format: date-time
computed_at
string format: date-time
tenants
array | object | null
Example
{
  "meta": {
    "range": "1h",
    "granularity": "hour"
  }
}

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"
    ]
  }
}