logo
WarmupPer-mailbox warmup metrics
Warmup

Per-mailbox warmup metrics

Returns detailed warmup metrics for a specific mailbox including placement breakdown (inbox/spam/promotions/other/not_detected) and daily stats sorted by date ascending.

curl -X GET "https://api.sendkit.ai/v1/warmup/stats/example_string?days=42" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "mailbox": {
      "id": "664a1b2c3d4e5f6a7b8c9d03",
      "email": "sales@mycompany.com",
      "displayName": "Sales Team"
    },
    "warmup": {
      "enabled": true,
      "status": "in_progress",
      "currentDay": 14,
      "currentVolume": 25,
      "config": {},
      "metrics": {},
      "startedAt": "2024-05-18T10:00:00.000Z"
    },
    "totalSent": 350,
    "placementBreakdown": {
      "inbox": 295,
      "spam": 30,
      "promotions": 15,
      "other": 2,
      "not_detected": 8
    },
    "dailyStats": [
      {
        "_id": "2024-05-28",
        "sent": 25,
        "inbox": 22,
        "spam": 2,
        "replied": 5,
        "opened": 20
      },
      {
        "_id": "2024-05-29",
        "sent": 25,
        "inbox": 21,
        "spam": 3,
        "replied": 6,
        "opened": 19
      },
      {
        "_id": "2024-05-30",
        "sent": 25,
        "inbox": 23,
        "spam": 1,
        "replied": 4,
        "opened": 22
      }
    ],
    "days": 30
  }
}
GET
/v1/warmup/stats/{mailboxId}
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
query
daysinteger

Number of days to aggregate stats over (default 30, max 90)

Max: 90
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Path Parameters

Query Parameters

daysinteger

Number of days to aggregate stats over (default 30, max 90)

Responses

successboolean
dataobject