logo
AnalyticsMailbox performance

Mailbox performance

Returns performance metrics for all mailboxes in the workspace. Includes send stats, bounce rate, daily limits, warmup status, and aggregated campaign email performance (sent, opened, clicked, bounced, replied) with rates.

Without from/to, returns all-time data. Supply one or both to filter by date range.

curl -X GET "https://api.sendkit.ai/v1/analytics/mailboxes?from=2024-05-01&to=2024-05-31" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": [
    {
      "_id": "example_string",
      "email": "user@example.com",
      "displayName": "John Doe",
      "status": "active",
      "totalSent": 42,
      "totalReceived": 42,
      "bounceRate": 3.14,
      "sentToday": 42,
      "dailySendLimit": 42,
      "warmup": {
        "enabled": true,
        "status": "example_string"
      },
      "performance": {
        "sent": 42,
        "opened": 42,
        "clicked": 42,
        "bounced": 42,
        "replied": 42,
        "positiveReplied": 42
      },
      "rates": {
        "open": "25.0",
        "click": "3.5",
        "bounce": "1.2",
        "reply": "5.0",
        "positiveReply": "2.0"
      }
    }
  ]
}
GET
/v1/analytics/mailboxes
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_...)
query
fromstring

Start date (ISO 8601 or date string). Omit for no lower bound.

Format: date
query
tostring

End date (ISO 8601 or date string). Omit for no upper bound.

Format: date
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_...)

Query Parameters

fromstring

Start date (ISO 8601 or date string). Omit for no lower bound.

tostring

End date (ISO 8601 or date string). Omit for no upper bound.

Responses

successboolean
dataarray