---
title: "Get the domain burn report"
method: GET
path: "/api/v1/domain-burn"
tags: ["Domain Burn Alerts"]
---

# Get the domain burn report

`GET /api/v1/domain-burn`

## Request

- Base URL: `https://api.aerosend.io`
- URL: `https://api.aerosend.io/api/v1/domain-burn`
- Auth: API key in header `X-API-Key`

Returns summary counts (total, burnt, at-risk, good, excellent, low-volume), status groups,
end clients derived from redirect URLs, and one row per domain.

Without `id`, this is the entire customer report. With `id` from GET /keys, the report
is limited to domains on that Smartlead or Instantly key
(`customer_integrations.mb_integration_id` → `client_integrations.id`).

`data.scan` is the same status object as GET /scan-score (`NOT_STARTED`, `IN_PROGRESS`,
`COMPLETED`, `FAILED` and `next_step`). When no report exists yet, `report_available` is
false and `scan.next_step` tells the UI whether to connect a sequencer, generate the report, or wait.

## Query parameters

- `id` integer
- `offset` integer
- `limit` integer

## Response `200`

Domain burn report with summary counts and per-domain rows

- DomainBurnReportApiResponse
  - `success` boolean: Success flag
  - `data` DomainBurnReport: Domain Burn Alerts report for the authenticated client
    - `reportAvailable` boolean: False until a scan has produced a report; summary/domains are empty then
    - `scan` ScanScore: Domain Burn scan / report status for the authenticated client
      - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED': Scan / report status
      - `reportExists` boolean: True when a completed report is available (possibly from an earlier scan)
      - `nextStep` 'CONNECT_SEQUENCER' | 'WAIT' | 'VIEW_REPORT' | 'RETRY_SCAN': What the UI should do next
      - `message` string: Human readable explanation of the status
      - `startedAt` string, date-time: When the latest scan was started
      - `completedAt` string, date-time: When the latest report was produced
      - `sequencers` SequencerInfo[]: Connected sequencers (keys are never returned)
        - `sequencer` string
        - `connected` boolean
        - `accountCount` integer: Number of active API keys for this sequencer
        - `scanSupported` boolean: False when DBA ingestion cannot scan this sequencer yet
    - `summary` DomainBurnSummary
      - `totalDomains` integer
      - `burnt` integer
      - `atRisk` integer
      - `good` integer
      - `excellent` integer
      - `lowVolume` integer
      - `clientCount` integer: Distinct end clients (redirect URLs)
      - `metricsDate` string, date: Latest scoring date
      - `reportFromDate` string, date: Start of the scored period
      - `reportToDate` string, date: End of the scored period
    - `groups` DomainBurnGroup[]: Status groups in display order, with the bulk action for each
      - `status` string
      - `label` string
      - `description` string
      - `count` integer
      - `action` string: Bulk action key: replace or slowdown; null when none
      - `actionLabel` string
    - `clients` DomainBurnClient[]: End clients derived from domain redirect URLs, plus 'all' and 'unassigned'
      - `id` string
      - `name` string
      - `color` string
      - `domainCount` integer
      - `unassigned` boolean
    - `domains` DomainBurnDomain[]
      - `domain` string
      - `status` string
      - `burnScore` integer: Burn score (0-100); null when low-volume
      - `sent` integer: Emails sent in the scored period
      - `delta` integer: Score change vs previous period
      - `flags` string[]
      - `clientName` string
      - `metricsDate` string, date
    - `pagination` DomainBurnPagination: Offset pagination for domain rows
      - `offset` integer
      - `limit` integer
      - `total` integer
      - `hasMore` boolean
  - `timestamp` string: Response timestamp

## Other responses

- `401`: Unauthorized - Invalid or expired API key
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/aerosend/apis/aerosend-developer-api.md) · [All operations](https://skmtc.dev/aerosend/apis/aerosend-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aerosend/apis/aerosend-developer-api/revisions/9828eeb89b1f?raw)