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"
import requests
import json
url = "https://api.sendkit.ai/v1/analytics/mailboxes?from=2024-05-01&to=2024-05-31"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/analytics/mailboxes?from=2024-05-01&to=2024-05-31", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.sendkit.ai/v1/analytics/mailboxes?from=2024-05-01&to=2024-05-31", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/analytics/mailboxes?from=2024-05-01&to=2024-05-31')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"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"
}
}
]
}
/v1/analytics/mailboxes
Platform API key (sk_user_...) or Workspace API key (sk_...)
Start date (ISO 8601 or date string). Omit for no lower bound.
End date (ISO 8601 or date string). Omit for no upper bound.
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Query Parameters
Start date (ISO 8601 or date string). Omit for no lower bound.
End date (ISO 8601 or date string). Omit for no upper bound.
Responses
activeinactivesuspendederrorTotal emails sent from this mailbox (stored counter)
Total emails received by this mailbox
Bounce rate as a decimal (e.g. 0.03)
Emails sent today
Max emails per day
Aggregated campaign email performance
Replies with a positive AI tag
Performance rates as percentages
Last updated 5 days ago
Built with Documentation.AI