GET /email_delivery/emails/stats/timeseries

GET email_delivery/emails/stats/timeseries

Retrieve timeseries statistics for email deliveries grouped by date

period_from string Required
example 2021-07-06T00:00:00.000Z

period_to string Required
example 2021-07-06T00:00:00.000Z

offset string
Number of items to skip before starting to return results

limit string
Maximum number of items to return per request

domain string
Filter by domain (partial string match)

status string
Filter by status. Can be a single value, comma-separated values, or JSON array.

sort string
Sort results by field.

dataarray
- datestring
  Date in YYYY-MM-DD format
- total_countinteger
  Total number of email deliveries for this date
- requestedinteger
  Number of emails with status REQUESTED
- sendinginteger
  Number of emails with status SENDING
- deliveredinteger
  Number of emails with status DELIVERED
- openedinteger
  Number of delivered emails that were opened
- clickedinteger
  Number of delivered emails where links were clicked
- unsubscribedinteger
  Number of delivered emails where recipient unsubscribed
- hard_bouncedinteger
  Number of hard bounces
- bouncedinteger
  Number of soft bounces
- spam_reportedinteger
  Number of spam reports
- dropped_unsubscribedinteger
  Emails dropped due to unsubscribe
- dropped_hard_bouncedinteger
  Emails dropped due to hard bounce
- dropped_spam_reportedinteger
  Emails dropped due to spam report
- dropped_manually_suppressedinteger
  Emails dropped due to manual suppression
metaobject
Pagination metadata for list responses
- countinteger
  Total number of items available
- offsetinteger
  Number of items skipped
- limitinteger
  Maximum number of items returned per request

Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error

email_delivery/emails/stats/timeseries