Get email deliverability — Brigg developers

Access & visibility

Allow workspace.GetEmailDeliverability on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request

No parameters. Send an empty JSON object ({}).

Response

Returns 200 OK with a JSON body.

tierstringRequired

The trust tier.

Allowed: "trial", "free", "paid".

quotaGetEmailDeliverabilityQuotaRequired

Current email sending allowance.

GetEmailDeliverabilityQuota

sent_todaynumberRequired

Messages counted against today's sending limit.

limitnumberRequired

Number of results to request per page.

remainingnumberRequired

Messages remaining within the current sending allowance.

levelnumberRequired

Current email sending tier.

next_limitnull or numberRequired

Sending allowance at the next tier.

clean_days_to_nextnull or numberRequired

Additional clean sending days needed before the next tier can be considered.

statestringRequired

The send state.

Allowed: "healthy", "approaching", "at_limit", "paused".

pausedbooleanRequired

Whether sending is currently paused.

paused_reasonstring or nullRequired

Reason sending is paused, when one is recorded.

killedbooleanRequired

Whether sending has been disabled by a protection rule.

windowGetEmailDeliverabilityWindowRequired

Reporting window used for these email delivery measurements.

GetEmailDeliverabilityWindow

daysnumberRequired

Number of days in the selected retention or reporting interval.

sentnumberRequired

Messages sent in the reporting window.

deliverednumberRequired

Messages with a recorded successful delivery.

openednumberRequired

Messages with a recorded open event; this is not proof a person read the content.

clickednumberRequired

Messages with a recorded link-click event.

bouncednumberRequired

Messages reported as bounced by the delivery provider.

complainednumberRequired

Messages associated with a recipient complaint.

bounce_ratenumberRequired

Fraction of sent messages that bounced, from 0 to 1.

complaint_ratenumberRequired

Fraction of sent messages with a complaint, from 0 to 1.

trendGetEmailDeliverabilityTrendRequired

Recent changes in email delivery measurements.

GetEmailDeliverabilityTrend

deliverednumberRequired

Messages with a recorded successful delivery.

bouncednumberRequired

Messages reported as bounced by the delivery provider.

complainednumberRequired

Messages associated with a recipient complaint.

nudgestring or nullRequired

complaint | bounce | null

heldnumberRequired

Messages held instead of being sent.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "tier": {
      "description": "The trust tier.",
      "title": "GetEmailDeliverabilityTier",
      "type": "string",
      "enum": [
        "trial",
        "free",
        "paid"
      ]
    },
    "quota": {
      "description": "Current email sending allowance.",
      "title": "GetEmailDeliverabilityQuota",
      "type": "object",
      "properties": {
        "sent_today": {
          "type": "number",
          "description": "Messages counted against today's sending limit."
        },
        "limit": {
          "type": "number",
          "description": "Number of results to request per page."
        },
        "remaining": {
          "type": "number",
          "description": "Messages remaining within the current sending allowance."
        },
        "level": {
          "type": "number",
          "description": "Current email sending tier."
        },
        "next_limit": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "type": "number"
            }
          ],
          "description": "Sending allowance at the next tier."
        },
        "clean_days_to_next": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "type": "number"
            }
          ],
          "description": "Additional clean sending days needed before the next tier can be considered."
        }
      },
      "required": [
        "sent_today",
        "limit",
        "remaining",
        "level",
        "next_limit",
        "clean_days_to_next"
      ],
      "additionalProperties": false
    },
    "state": {
      "description": "The send state.",
      "title": "GetEmailDeliverabilityState",
      "type": "string",
      "enum": [
        "healthy",
        "approaching",
        "at_limit",
        "paused"
      ]
    },
    "paused": {
      "type": "boolean",
      "description": "Whether sending is currently paused."
    },
    "paused_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Reason sending is paused, when one is recorded."
    },
    "killed": {
      "type": "boolean",
      "description": "Whether sending has been disabled by a protection rule."
    },
    "window": {
      "description": "Reporting window used for these email delivery measurements.",
      "title": "GetEmailDeliverabilityWindow",
      "type": "object",
      "properties": {
        "days": {
          "type": "number",
          "description": "Number of days in the selected retention or reporting interval."
        },
        "sent": {
          "type": "number",
          "description": "Messages sent in the reporting window."
        },
        "delivered": {
          "type": "number",
          "description": "Messages with a recorded successful delivery."
        },
        "opened": {
          "type": "number",
          "description": "Messages with a recorded open event; this is not proof a person read the content."
        },
        "clicked": {
          "type": "number",
          "description": "Messages with a recorded link-click event."
        },
        "bounced": {
          "type": "number",
          "description": "Messages reported as bounced by the delivery provider."
        },
        "complained": {
          "type": "number",
          "description": "Messages associated with a recipient complaint."
        },
        "bounce_rate": {
          "type": "number",
          "description": "Fraction of sent messages that bounced, from 0 to 1."
        },
        "complaint_rate": {
          "type": "number",
          "description": "Fraction of sent messages with a complaint, from 0 to 1."
        }
      },
      "required": [
        "days",
        "sent",
        "delivered",
        "opened",
        "clicked",
        "bounced",
        "complained",
        "bounce_rate",
        "complaint_rate"
      ],
      "additionalProperties": false
    },
    "trend": {
      "description": "Recent changes in email delivery measurements.",
      "title": "GetEmailDeliverabilityTrend",
      "type": "object",
      "properties": {
        "delivered": {
          "type": "number",
          "description": "Messages with a recorded successful delivery."
        },
        "bounced": {
          "type": "number",
          "description": "Messages reported as bounced by the delivery provider."
        },
        "complained": {
          "type": "number",
          "description": "Messages associated with a recipient complaint."
        }
      },
      "required": [
        "delivered",
        "bounced",
        "complained"
      ],
      "additionalProperties": false
    },
    "nudge": {
      "type": [
        "string",
        "null"
      ],
      "description": "complaint | bounce | null"
    },
    "held": {
      "type": "number",
      "description": "Messages held instead of being sent."
    }
  },
  "required": [
    "tier",
    "quota",
    "state",
    "paused",
    "paused_reason",
    "killed",
    "window",
    "trend",
    "nudge",
    "held"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "tier": "trial",
      "quota": {
        "sent_today": 25,
        "limit": 100,
        "remaining": 75,
        "level": 1,
        "next_limit": 200,
        "clean_days_to_next": 3
      },
      "state": "healthy",
      "paused": false,
      "paused_reason": null,
      "killed": false,
      "window": {
        "days": 7,
        "sent": 100,
        "delivered": 98,
        "opened": 40,
        "clicked": 10,
        "bounced": 2,
        "complained": 0,
        "bounce_rate": 0.02,
        "complaint_rate": 0
      },
      "trend": {
        "delivered": 98,
        "bounced": 2,
        "complained": 0
      },
      "nudge": null,
      "held": 0
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/workspace.GetEmailDeliverability' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/workspace.GetEmailDeliverability", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.GetEmailDeliverability",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/workspace.GetEmailDeliverability' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.GetEmailDeliverability", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.GetEmailDeliverability",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "tier": "trial",
  "quota": {
    "sent_today": 25,
    "limit": 100,
    "remaining": 75,
    "level": 1,
    "next_limit": 200,
    "clean_days_to_next": 3
  },
  "state": "healthy",
  "paused": false,
  "paused_reason": null,
  "killed": false,
  "window": {
    "days": 7,
    "sent": 100,
    "delivered": 98,
    "opened": 40,
    "clicked": 10,
    "bounced": 2,
    "complained": 0,
    "bounce_rate": 0.02,
    "complaint_rate": 0
  },
  "trend": {
    "delivered": 98,
    "bounced": 2,
    "complained": 0
  },
  "nudge": null,
  "held": 0
}

Illustrative values, not a live response.