Platform-wide accounts, signups and sending for administrators
1 endpoint
Endpoints
Method
Path
Description
GET
/v1/admin/stats
GET /v1/admin/stats
GET/v1/admin/stats
Platform-wide accounts, signup funnel, sending totals, a daily series and the largest senders for the window. Deliveries exclude sandbox and honeypot sends; signups exclude admins, honeypots, suspended or under-review accounts, the registration-burst wave, classifier-exempt accounts and sub-accounts; paying means a settled payment. Requires an admin account and the account:admin scope.
Parameters
Name
In
Type
Required
Description
period
query
string
No
Period shorthand: 7d, 30d, 90d (default: 30d)
from
query
string
No
Start date (YYYY-MM-DD), inclusive
to
query
string
No
End date (YYYY-MM-DD), inclusive
Responses
Status
Description
200
Platform statistics for the window
401
Unauthorized
403
Caller is not an admin, or the API key lacks account:admin
422
Invalid parameters
Example
curl -X GET https://api.euromail.dev/v1/admin/stats \ -H "X-EuroMail-Api-Key: em_live_..."
import { EuroMail } from "@euromail/sdk";const euromail = new EuroMail({ apiKey: "em_live_..." });const result = await euromail.getAdmin();
from euromail import EuroMailclient = EuroMail(api_key="em_live_...")result = client.get_admin()
use euromail::EuroMail;let client = EuroMail::new("em_live_...");let result = client.get_admin().await?;