← All API sections

Admin Stats

Platform-wide accounts, signups and sending for administrators

1 endpoint

Endpoints

MethodPathDescription
GET/v1/admin/statsGET /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

NameInTypeRequiredDescription
periodquerystringNoPeriod shorthand: 7d, 30d, 90d (default: 30d)
fromquerystringNoStart date (YYYY-MM-DD), inclusive
toquerystringNoEnd date (YYYY-MM-DD), inclusive

Responses

StatusDescription
200Platform statistics for the window
401Unauthorized
403Caller is not an admin, or the API key lacks account:admin
422Invalid 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 EuroMail

client = EuroMail(api_key="em_live_...")

result = client.get_admin()
use euromail::EuroMail;

let client = EuroMail::new("em_live_...");

let result = client.get_admin().await?;
client := euromail.NewClient("em_live_...")

result, err := client.GetAdmin(ctx)