---
title: "GET /v1/workspaces/{workspaceId}/deliverability"
method: GET
path: "/v1/workspaces/{workspaceId}/deliverability"
---

# GET /v1/workspaces/{workspaceId}/deliverability

`GET /v1/workspaces/{workspaceId}/deliverability`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/deliverability`
- Auth: HTTP bearer

## Query parameters

- `since` string, date-time

## Response `200`

Successful response.

- object
  - `data` DeliverabilitySummary, required
    - `counting_basis` 'recipients' | 'events'
    - `simulator_events` integer
    - `since` string, date-time, required
    - `generated_at` string, date-time, required
    - `totals` DeliverabilityCounts, required
      - `sent_count` integer
      - `delivered_count` integer
      - `deferred_count` integer
      - `bounced_count` integer
      - `complained_count` integer
      - `opened_count` integer
      - `clicked_count` integer
      - `unsubscribed_count` integer
      - `failed_count` integer
      - `suppressed_count` integer
      - `last_event_at` string, date-time, nullable
    - `time_series` DeliverabilityTimeBucket[], required
      - `sent_count` integer
      - `delivered_count` integer
      - `deferred_count` integer
      - `bounced_count` integer
      - `complained_count` integer
      - `opened_count` integer
      - `clicked_count` integer
      - `unsubscribed_count` integer
      - `failed_count` integer
      - `suppressed_count` integer
      - `last_event_at` string, date-time, nullable
      - `bucket` string, date, required
    - `providers` DeliverabilityProvider[], required
      - `sent_count` integer
      - `delivered_count` integer
      - `deferred_count` integer
      - `bounced_count` integer
      - `complained_count` integer
      - `opened_count` integer
      - `clicked_count` integer
      - `unsubscribed_count` integer
      - `failed_count` integer
      - `suppressed_count` integer
      - `last_event_at` string, date-time, nullable
      - `provider_connection_id` string, uuid, nullable
      - `provider` string, required
      - `display_name` string, required
      - `ownership` string, required
      - `status` string, required
    - `recipient_domains` DeliverabilityRecipientDomain[], required
      - `sent_count` integer
      - `delivered_count` integer
      - `deferred_count` integer
      - `bounced_count` integer
      - `complained_count` integer
      - `opened_count` integer
      - `clicked_count` integer
      - `unsubscribed_count` integer
      - `failed_count` integer
      - `suppressed_count` integer
      - `last_event_at` string, date-time, nullable
      - `recipient_domain` string, required
    - `sending_streams` DeliverabilitySendingStream[], required
      - `id` string, uuid, required
      - `domain` string, required
      - `stream_kind` string, required
      - `display_name` string, required
      - `status` string, required
      - `status_reason` string, nullable
      - `provider_status` string, nullable
      - `required_records` integer, required
      - `verified_records` integer, required
      - `pending_records` integer, required
      - `error_records` integer, required
      - `last_checked_at` string, date-time, nullable
    - `feedback_pipeline` object, required
      - `status` 'healthy' | 'degraded' | 'unproven', required
      - `eligible_attempts` integer, required
      - `unmatched_attempts` integer, required
      - `last_receipt_at` string, date-time, nullable
    - `issues` DeliverabilityIssue[], required
      - `severity` 'warning' | 'critical', required
      - `code` string, required
      - `title` string, required
      - `detail` string, required
      - `resource_kind` string, required
      - `resource_id` string, required

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)