Per-mailbox analytics
Returns detailed analytics for a single mailbox, including:
- Mailbox info (email, displayName, status)
- Aggregated campaign email stats (sent, opened, clicked, bounced, replied)
- Computed rates (open, click, bounce, reply)
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/example_string?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/example_string?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/example_string?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/example_string?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/example_string?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": {
"mailbox": {
"id": "example_string",
"email": "user@example.com",
"displayName": "John Doe",
"status": "example_string"
},
"stats": {
"sent": 42,
"opened": 42,
"clicked": 42,
"bounced": 42,
"replied": 42,
"positiveReplied": 42
},
"rates": {
"open": "example_string",
"click": "example_string",
"bounce": "example_string",
"reply": "example_string",
"positiveReply": "example_string"
}
}
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
GET
/v1/analytics/mailboxes/{mailboxId}GET
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
path
mailboxIdstring
RequiredMailbox ID
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
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Path Parameters
mailboxIdstring
RequiredMailbox ID
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
dataobject
mailboxobject
idstring
emailstring
displayNamestring
statusstring
statsobject
sentinteger
openedinteger
clickedinteger
bouncedinteger
repliedinteger
positiveRepliedinteger
Replies with a positive AI tag
ratesobject
openstring
clickstring
bouncestring
replystring
positiveReplystring
Mailbox not found
Was this page helpful?
Last updated today
Built with Documentation.AI