For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stats

Email sending stats

Email sending aggregated stats. The same you see in your Stats dashboard.

Get Sending Stats

get

Get account sending stats. Use filters to get specific stats.

Authorizations
Api-TokenstringRequired

API token in Api-Token header

Query parameters
start_datestring · dateRequired

Start date for which to include the results.

Example: 2025-01-01
end_datestring · dateRequired

End date for which to include the results.

Example: 2025-12-31
domain_ids[]integer · int64[]Optional

IDs of the domains for which to include the results. If not provided, results for all domains will be included.

Example: [3938,3939]
categories[]string[]Optional

Categories for which to include the results. If not provided, results for all categories will be included.

Example: ["Welcome Email","Password Reset"]
Responses
200

OK

application/json
delivery_countintegerOptionalExample: 190
delivery_ratenumber · doubleOptionalExample: 0.95
bounce_countintegerOptionalExample: 10
bounce_ratenumber · doubleOptionalExample: 0.05
open_countintegerOptionalExample: 171
open_ratenumber · doubleOptionalExample: 0.9
click_countintegerOptionalExample: 133
click_ratenumber · doubleOptionalExample: 0.7
spam_countintegerOptionalExample: 3
spam_ratenumber · doubleOptionalExample: 0.02
get/api/stats

Get Sending Stats by Domains

get

Get account sending stats by domains. Use filters to get specific stats.

Authorizations
Api-TokenstringRequired

API token in Api-Token header

Query parameters
start_datestring · dateRequired

Start date for which to include the results.

Example: 2025-01-01
end_datestring · dateRequired

End date for which to include the results.

Example: 2025-12-31
domain_ids[]integer · int64[]Optional

IDs of the domains for which to include the results. If not provided, results for all domains will be included.

Example: [3938,3939]
categories[]string[]Optional

Categories for which to include the results. If not provided, results for all categories will be included.

Example: ["Welcome Email","Password Reset"]
Responses
200

OK

application/json
domain_idinteger · int64OptionalExample: 3938
get/api/stats/domains

Get Sending Stats by Categories

get

Get account sending stats by categories. Use filters to get specific stats.

Authorizations
Api-TokenstringRequired

API token in Api-Token header

Query parameters
start_datestring · dateRequired

Start date for which to include the results.

Example: 2025-01-01
end_datestring · dateRequired

End date for which to include the results.

Example: 2025-12-31
domain_ids[]integer · int64[]Optional

IDs of the domains for which to include the results. If not provided, results for all domains will be included.

Example: [3938,3939]
categories[]string[]Optional

Categories for which to include the results. If not provided, results for all categories will be included.

Example: ["Welcome Email","Password Reset"]
Responses
200

OK

application/json
categorystringOptionalExample: Welcome Email
get/api/stats/categories

Get Sending Stats by Email Service Providers

get

Get account sending stats by email service providers. Use filters to get specific stats.

Authorizations
Api-TokenstringRequired

API token in Api-Token header

Query parameters
start_datestring · dateRequired

Start date for which to include the results.

Example: 2025-01-01
end_datestring · dateRequired

End date for which to include the results.

Example: 2025-12-31
domain_ids[]integer · int64[]Optional

IDs of the domains for which to include the results. If not provided, results for all domains will be included.

Example: [3938,3939]
categories[]string[]Optional

Categories for which to include the results. If not provided, results for all categories will be included.

Example: ["Welcome Email","Password Reset"]
Responses
200

OK

application/json
email_service_providerstringOptionalExample: Google
get/api/stats/email_service_providers

Get Sending Stats by Date

get

Get account sending stats by date. Use filters to get specific stats.

Authorizations
Api-TokenstringRequired

API token in Api-Token header

Query parameters
start_datestring · dateRequired

Start date for which to include the results.

Example: 2025-01-01
end_datestring · dateRequired

End date for which to include the results.

Example: 2025-12-31
domain_ids[]integer · int64[]Optional

IDs of the domains for which to include the results. If not provided, results for all domains will be included.

Example: [3938,3939]
categories[]string[]Optional

Categories for which to include the results. If not provided, results for all categories will be included.

Example: ["Welcome Email","Password Reset"]
Responses
200

OK

application/json
datestring · dateOptionalExample: 2025-01-01
get/api/stats/date

Last updated

Was this helpful?