Skip to content

Get platform statistics

Request

Breakdown of email opens by email client platform (Gmail, Outlook, Apple Mail, etc.).

Use domain_id to filter statistics for a specific sending domain.

Security
ApiKeyAuth
Query
fromdatestring
Example:fromdate=2024-03-01T00:00:00Z
One of:

Start date or timestamp for filtering (ISO 8601). Date-only values start at 00:00:00 UTC.

string (date)
todatestring
Example:todate=2024-03-31T23:59:59Z
One of:

End date or timestamp for filtering (ISO 8601). Date-only values include the full UTC calendar day.

string (date)
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/opens/platforms?fromdate=2024-03-01T00%3A00%3A00Z&todate=2024-03-31T23%3A59%3A59Z&domain_id=123' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Platform statistics retrieved successfully

Bodyapplication/json
platformsArray of objects
Response
{ "platforms": [ { … }, { … }, { … }, { … } ] }