View sent emails stats

https://areamembri.it/sent_emails/view_sent_emails_stats.json

Retrieve the stats (deliveries, opens, clicks…) for a broadcast or followup with optional per-user details.

Parameters:

api_user The provided API User credential for your account.
api_key The provided API Key credential for your account.
business_id

(optional)

The project ID you want to query in. If not specified, the account will be used.
action_id

(mutually exclusive)

The followup ID you want to query.
broadcast_id

(mutually exclusive)

The broadcast ID you want to query.
details

(optional)

If you want to get the per-user details. Defaults to false.
user_email

(optional)

If you want to get the stats only for one user, specifying it’s email.

Return:

An object, with these fields:

  • action_id or broadcast_id: forwarded from the parameters.
  • delivered: total number of emails sent.
  • opens: number of opened emails.
  • clicks: number of emails with clicked links.
  • emails: (only if “details” parameter is true) array of objects, each one containing:
    • user_id: the user’s ID.
    • user_email: the user’s email.
    • user_name: the full user’s name.
    • clicked: if the user clicked any link on the email.
    • click_date: the date for the first click, if any.
    • opened: if the user opened the email.
    • open_date: the date the user opened the email for the first time, if ever opened.