In this section:

Querying a Response Summary

Returns the summary of the responses of a launched, paused, activated or deactivated email campaign. Requires the use of the Querying Responses endpoint to provide exact contact IDs.

Endpoint

GET https://api.emarsys.net/api/v2/email/<email_id>/responsesummary

Parameters

Required parameters

Name Type Description Comments
email_id int ID of the email, part of the URI  

Optional parameters

Name Type Description Comments
launch_id int ID of the launch, part of the URI (e.g. /api/v2/email/<email_id>/responsesummary/?launch_id=<launch_id>  
start_date date Returns the response summary from the given time Accepted forms are YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD.
end_date date Returns the response summary until the given time Accepted forms are YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD.

Result Example

{
  "replyCode": 0,
  "replyText": "OK",
  "data":
  {
    "sent": "3",
    "planned": "3",
    "soft_bounces": "0",
    "hard_bounces": "0",
    "block_bounces": "0",
    "opened": "2",
    "unsubscribe": "0",
    "total_clicks": "0",
    "unique_clicks": "0",
    "complained": "0",
    "launches": "2"
  }
}

Where

  • sent = The number of emails which have actually left the Suite mail servers.
  • planned = The number of all contacts which are assigned to this launch.
  • soft_bounces = The number of emails which were returned to sender due to temporary problems.
  • hard_bounces = The number of emails which were returned to sender due to permanent problems.
  • block_bounces = The number of emails which were returned to sender due to being blocked by spam filters.
  • opened = The number of emails which were opened by recipients; the open rate refers to graphic (HTML) emails only, where the images were downloaded..
  • unsubscribe = The number of clicks on the unsubscribe link.
  • total_clicks = The number of total clicks on links tracked by the Suite within an email (multiple clicks per contact are counted).
  • unique_clicks = The number of unique clicks on links tracked by the Suite within an email (one click per contact is counted).
  • complained = The number of recipients who marked this email as spam in their email client.
  • launches = The number of launches between the given time range. If launch_id and dates are given too, the program return the number of launches with the same id as given (if the table contains ids) or it returns the number of launches between the given dates (if the table contains dates).

Errors

HTTP Code Reply Code Message Description
400 6400 Invalid email ID No email with the provided ID exists.
400 6003 Invalid email status The status of the email is not one of the following: launched, paused, activated, deactivated.