Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Agentboxd Com Metrics API
version: '1'
contact:
name: Agentboxd
url: https://agentboxd.com
email: hello@agentboxd.com
description: 'Operations tagged Metrics across 2 of this provider''s published API definitions: agentboxd-com-openapi.json, agentboxd-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.agentboxd.com
security:
- apiKey: []
tags:
- name: Metrics
description: Sending, delivery and bounce numbers.
paths:
/v1/deliverability:
get:
operationId: getDeliverability
tags:
- Metrics
summary: Get bounce and complaint rates
description: 'Your bounce and complaint rates over 7 and 30 days with the thresholds at which sending pauses, suppressed contacts, your domains’ SPF/DKIM/DMARC status and our shared IP’s blocklist status. Needs `metrics:read`; workspace keys only. See Deliverability.
Permission: `metrics:read`.'
x-permission: metrics:read
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.agentboxd.com
/v1/metrics:
get:
operationId: getMetrics
tags:
- Metrics
summary: Get sending and receiving metrics
description: '`?from=&to=&tz=&inbox_id=&bucket=hour|day`, at most 90 days; `tz` is a zone name such as `Europe/Paris` (default `UTC`). Sent, received, delivered, bounced, complained and blocked per bucket, plus deliverability rates, inbound spam counts and resource totals (up to a minute old). `queue` lists every inbox that uses the claim/ack queue with `depth` (waiting), `in_flight` (live leases), `dead_letters` and `oldest_waiting_at`. Needs `metrics:read`. At most 30 calls a minute per workspace, across all its keys: `429 rate_limited` with `Retry-After`.
Permission: `metrics:read`.'
x-permission: metrics:read
parameters:
- name: from
in: query
required: false
schema:
type: string
- name: to
in: query
required: false
schema:
type: string
- name: tz
in: query
required: false
schema:
default: UTC
type: string
minLength: 1
maxLength: 64
- name: inbox_id
in: query
required: false
schema:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- name: bucket
in: query
required: false
schema:
default: day
type: string
enum:
- hour
- day
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.agentboxd.com
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Stable, machine-readable error code.
message:
type: string
description: What happened and how to fix it, in plain words.
details:
description: 'The specifics: which recipient, which limit, until when.'
docs_url:
type: string
format: uri
description: 'For a refused send: its entry on "Why was my send refused?" (https://agentboxd.com/docs/send-refusals).'
securitySchemes:
apiKey:
type: http
scheme: bearer
description: An API key (`mr_…`), scoped to the workspace or one inbox, with a set of permissions.
externalDocs:
description: API reference
url: https://agentboxd.com/docs/api
x-refined-from:
- agentboxd-com-openapi.json
- agentboxd-com-openapi.json