analytics
Export Analytics data in CSV file
Export Analytics data in CSV file
get/analytics/csv
Query parameters
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
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
Filter by
[ "subject" ]
filterstring
Query to search
Text to search (recipient, sender, email subject or reason for suppression)
smart_searchboolean nullable
Smart search
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
Analytics CSV data