Get warmup stats

API referenceWarmup

From the Warmup API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

text

GET /warmup/stats

Returns a point-in-time summary across your accounts: how many are active, aging, or paused, how many warmup emails have gone out today, and the average health score.

X-Project-Id is optional here, omit it to get stats across every project in your active workspace (the one named in X-Workspace-Id if you belong to it, otherwise your own workspace), or pass it to scope the numbers to a single project in that workspace.

bash

curl https://app.warmerly.com/api/v1/warmup/stats \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-Project-Id: 8f14e45f-ceea-4c6a-8c8d-6b1a5b5c9c1a"

json

{
  "activeAccounts": 12,
  "agingAccounts": 3,
  "pausedAccounts": 1,
  "todaySent": 84,
  "todayScheduled": 12,
  "todayPlanned": 96,
  "todayFailed": 0,
  "todayTarget": 110,
  "avgHealthScore": 87
}

Field	Type	Description
`activeAccounts`	integer	Accounts with `status = active` (past the ramp period).
`agingAccounts`	integer	Accounts still ramping up (`status = aging`).
`pausedAccounts`	integer	Accounts with `status = paused`.
`todaySent`	integer	Warmup emails sent today, summed from each mailbox's own day (its local timezone).
`todayScheduled`	integer	Warmup emails still pending for today.
`todayPlanned`	integer	Everything on today's schedule, in any status.
`todayFailed`	integer	Warmup emails that failed today.
`todayTarget`	integer	The sum of each mailbox's target for today.
`avgHealthScore`	integer \\| null	Average `last_health_score` across accounts that have one.

Was this page helpful?

Get warmup stats

More from Warmup