Skip to content
builders.ac

Deliverability API · Alpha / unstable

Retrieve the traffic time series

GET
/timeseries
curl --request GET \
  --url 'https://api.builders.ac/api/deliverability/v1alpha1/timeseries?range=1h' \
  --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.

Responses

Section titled “Responses”

200

Section titled “200”

Traffic time series

Media typeapplication/json
object
trend
required
Array<object>
object
day
required
string
date
string format: date
state
string
sent
integer | null
received
integer | null
outreach
integer | null
warmup
integer | null
reply
integer | null
autoresponse
integer | null
other
integer | null
system
integer | null
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"
    ]
  }
}