Get outbound statistics overview

Request

Overview of all outbound email statistics with optional date filtering.

Domain Filtering - Use the domain_id parameter to get statistics for a specific sending domain only.

Confidence-Based Scanner Detection - Use the filter parameter to exclude bot/scanner engagement and get accurate human-only metrics.

The system now uses a confidence score (0-100) to classify engagement:

scanner (>= 80): Known email security systems and bots
suspicious (50-79): Edge cases that may be automated
human (< 50): Real user engagement

Gmail and Outlook Web clicks are correctly classified as "human" since these clients strip referrer headers for privacy but show other human signals (residential IP, real browser UA, normal timing).

Security

ApiKeyAuth

Query

fromdatestring, (date-time)

Start date for filtering (ISO 8601)

Example:fromdate=2024-03-01T00:00:00Z

todatestring, (date-time)

End date for filtering (ISO 8601)

Example:todate=2024-03-31T23:59:59Z

filterstring

Filter statistics by engagement type (NEW - Scanner Detection Feature):

all (default): All opens/clicks including scanners
human_only: Only real human engagement
scanner_only: Only bot/scanner engagement

Default:"all"

Enum:"all""human_only""scanner_only"

Example:filter=human_only

domain_idinteger

Filter statistics by specific sending domain ID

Example:domain_id=123

curl -i -X GET \
  'https://api.mailerlogic.net/api/v1/stats/outbound?fromdate=2024-03-01T00%3A00%3A00Z&todate=2024-03-31T23%3A59%3A59Z&filter=human_only&domain_id=123' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Statistics retrieved successfully

Bodyapplication/json

sentinteger

deliveredinteger

bouncedinteger

failedinteger

opensinteger

Total opens (filtered by filter parameter)

unique_opensinteger

Unique opens (filtered by filter parameter)

clicksinteger

Total clicks (filtered by filter parameter)

human_opensinteger

NEW - Confidence-Based Detection: Opens classified as human (confidence < 50). Real user engagement excluding Gmail/Outlook image prefetch and security scanners.

scanner_opensinteger

NEW - Confidence-Based Detection: Opens classified as scanners (confidence >= 80). Known email security scanners, bots, and automated systems.

human_clicksinteger

NEW - Confidence-Based Detection: Clicks classified as human (confidence < 50). Real user clicks excluding security scanner pre-fetches.

scanner_clicksinteger

NEW - Confidence-Based Detection: Clicks classified as scanners (confidence >= 80). Automated clicks from security systems.

human_open_ratestring

Percentage of emails opened by real humans (human_opens / sent * 100)

Example:"15.50"

human_click_ratestring

Percentage of emails clicked by real humans (human_clicks / sent * 100)

Example:"8.25"

unique_clicksinteger

Unique clicks (filtered by filter parameter)

spam_complaintsinteger

trackedinteger

Total tracked events (opens + clicks, filtered by filter parameter)

Response

{
  "sent": 0,
  "delivered": 0,
  "bounced": 0,
  "failed": 0,
  "opens": 0,
  "unique_opens": 0,
  "clicks": 0,
  "human_opens": 0,
  "scanner_opens": 0,
  "human_clicks": 0,
  "scanner_clicks": 0,
  "human_open_rate": "15.50",
  "human_click_rate": "8.25",
  "unique_clicks": 0,
  "spam_complaints": 0,
  "tracked": 0
}