Skip to content

Get click statistics

Request

Daily or hourly breakdown of link clicks (total and unique).

Domain Filtering - Use domain_id to filter statistics for a specific sending domain.

Confidence-Based Scanner Detection - Use filter=human_only to exclude security scanner clicks for accurate click-through rates.

Clicks are classified with high accuracy:

  • human (< 50): Real clicks from Gmail, Outlook, mobile devices
  • suspicious (50-79): Fast clicks from cloud IPs with real browser UAs
  • scanner (>= 80): Proofpoint, Barracuda, Mimecast, curl, automated tools

Gmail and Outlook Web users clicking links are correctly identified as "human" even though these clients strip the Referer header.

Use precision to control time granularity (day or hour).

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
tagstring

Filter by email tag

Example:tag=newsletter
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
precisionstring

Time granularity for statistics aggregation:

  • day (default): Daily aggregation
  • hour: Hourly aggregation
Default:"day"
Enum:"day""hour"
Example:precision=hour
curl -i -X GET \
  'https://api.mailerlogic.net/api/v1/stats/outbound/clicks?fromdate=2024-03-01T00%3A00%3A00Z&todate=2024-03-31T23%3A59%3A59Z&tag=newsletter&filter=human_only&domain_id=123&precision=hour' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Click statistics retrieved successfully

Bodyapplication/json
daysArray of objects
Response
{
  "days": [
    { … }
  ]
}