v1

latestOpenAPI 3.1.0MIT2026-08-0652106151.4 KB

analytics

Get Analytics Data

get/analytics

Query parameters

pageinteger nullable

Page number. Must be an integer greater than 0.

Example:1

Page number

limitinteger nullable

The number of rows per page to return. Must be an integer greater than 0.

Example:10

The numbers of rows per page to return

fromstring date required

Start date

Example:2020-01-01

Start date (format YYYY-MM-DD). Must be less than or equal to the 'to' parameter.

tostring date required

End date

Example:2025-12-31

End date (format YYYY-MM-DD). Must be greater than or equal to the 'from' parameter.

status[]AnalyticMailStatus[]

Filter by Status

NEW: email has been queued for delivery
DEFER: email is in the queue for delivery
SUCCESS: email has been delivered.
OPEN: email has been opened.
CLICK: email has been clicked.
REPORT: email has been reported as spam.
FAIL: email has bounced.
SYSFAIL: email was dropped.
UNSUB: email is unsubscribed.

<br /> Notice that emails that fall into the above statuses can be grouped, ie Turbo-Smtp uses the following groups: <br />

'Clicks' = 'CLICK',
'Unsubscribes' = 'UNSUB',
'Spam' = 'REPORT',
'Drop' = 'SYSFAIL',
'Queued' = 'NEW' or 'DEFER',
'Opens'= 'OPEN' or 'CLICK' or 'UNSUB' or 'REPORT',
'Delivered'= 'SUCCESS'  or 'OPEN' or 'CLICK' or 'UNSUB' or 'REPORT',
'Bounce': 'FAIL'.

filter_byAnalyticFilterByOption[]

Filter by

[
  "subject"
]

filterstring

Query to search

Text to search (recipient, sender, email subject or reason for suppression)

smart_searchboolean nullable

Smart search

orderby'subject' | 'sender' | 'recipient' | 'send_time'

Field to sort by. Valid values are subject, sender, recipient, or send_time.

Example:send_time

Order by

ordertype'asc' | 'desc'

Order Ascending or Descending.

Example:desc

tzstring

Timezone Offset

Example:-07:00

Timezone Offset

Response

Sucess

Get Analytics Data.

countinteger

Example response

{
  "count": 2,
  "results": [
    {
      "id": 1800872493473407000,
      "subject": "Newsletter update",
      "sender": "sample@gmail.com",
      "recipient": "robert-doe@elecronic-arts.com",
      "send_time": "2023-08-10 04:04:21",
      "status": "SUCCESS",
      "domain": "gmail.com",
      "error": "",
      "recipient_domain": "electronic-arts.com",
      "x_campaign_id": "Offer AB Test."
    },
    {
      "id": 1800871904471490600,
      "subject": "New Movies",
      "sender": "sales@gmail.com",
      "recipient": "jhon-doe@datamart.com",
      "send_time": "2023-08-11 04:04:21",
      "status": "FAIL",
      "domain": "gmail.com",
      "error": "142.250.138.27 does not like recipient.\\nRemote host said: 550-5.1.1 The email account does not exist.",
      "recipient_domain": "datamart.com",
      "x_campaign_id": "Offer AB Test."
    }
  ]
}