Analytics

Access your account statistics

Overview

Retrieves the global statistics for your account.

GET /api/v1/analytics

Required scope: analytics:read

Example

curl -X GET https://api.junkmail.dev/api/v1/analytics \
  -H "Authorization: Bearer jm_live_xxxx"

JavaScript

const response = await fetch('https://api.junkmail.dev/api/v1/analytics', {
  headers: {
    'Authorization': 'Bearer jm_live_xxxx',
  },
});

const { totalAddresses, activeAddresses, thisMonthReceived } = await response.json();

Response

{
  "totalAddresses": 25,
  "activeAddresses": 12,
  "totalEmailsReceived": 1547,
  "totalEmailsSent": 89,
  "thisMonthReceived": 234,
  "thisMonthSent": 15
}

Response Fields

Field	Type	Description
totalAddresses	number	Total number of addresses created
activeAddresses	number	Number of currently active addresses
totalEmailsReceived	number	Total emails received since account creation
totalEmailsSent	number	Total emails sent since account creation
thisMonthReceived	number	Emails received this month
thisMonthSent	number	Emails sent this month