There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

Get the statistics for a marketing email

Last updated June 17, 2020

GET /marketing-emails/v1/emails/with-statistics/:email_id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Get the statistics for a specific marketing email. These include the same parameters returned from the 'get all marketing emails' and 'get a marketing email' endpoints, in addition to the performance related metrics described in the table below.
Note: To fetch stats from a campaignid, please refer to the Email Events API.
Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 Used to authenticate the request. Please see this page for more details about authentication.
 Email ID /:email_id
 Used in the request URL		 The ID of the email that you want to get the details for. 

JSON Fields returned in the 'stats' field

Parameter name Type Description
sent Integer the total number of sent emails
open Integer The total number of unique opens
delivered Integer The number of emails succesfully delivered to an inbox
bounce Integer The number of times contacts were sent your email, but they didn’t receive it because either their address is invalid, your email hit their spam filter, or your email was marked as spam by other people.
unsubscribed Integer The number of contacts who received your email and unsubscribed. They won’t be sent to in the future.
click Integer The number of unique recipients who clicked on any link in your email, excluding the Unsubscribe and Subscription Preferences links.
dropped Integer The number of contacts that were not sent your email. This may be because they previously hard bounced, unsubscribed, marked you as spam, or because they have not engaged with any of your recent emails.
selected Integer  The number of contacts selected to receive this email.
spamreport Integer The number of contacts received your email and marked it as spam. They won’t be sent to in the future.
suppressed Integer The number of contacts that did not receive your email due to graymail suppression.
hardbounced Integer These contacts were sent your email, but they didn’t receive it because either their address is invalid, your email hit their spam filter, or your email was marked as spam by other people.
softbounced Integer Soft bounces occur when a contact’s inbox has a temporary problem. You can still send to these people in the future. Contacts who hard bounce will be ineligible for later sends.
pending Integer The number of emails still trying to reach a contact's inbox.
contactslost Integer The sum of contacts that have unsubscribed, marked the email as spam, or have hardbounced.
notsent Integer These contacts were not sent your email. This may be because they previously hard bounced, unsubscribed, marked you as spam, or because they have not engaged with any of your recent emails.
clickratio Integer Click rate is the percentage of people who clicked a link in your email out of the people who were delivered your email.
clickthroughratio Integer This is the percentage of people who clicked a link in your email out of the people who opened your email.
deliveredratio Integer the number of succesfull deliveries over the number of selected contacts.
openratio Integer Open rate is the percentage of people who opened your email out of the people who were delivered your email.
unsubscribedratio Integer the number of contacts that have unsubscribed over the total number of selected contacts
spamreportratio Integer The number of contacts that mark the email as spam over the total number of selected contacts.
hardbounceratio Integer The number of contacts that hard bounced from the email over the total number of selected contacts.
bounceratio Integer The number of contacts that bounced from the email over the total number of selected contacts.
softbounceratio Integer The number of contacts that soft bounced from the email over the total number of selected contacts.
contactslostratio Integer The number of contacts that can no longer recive emails from the portal over the total number of selected contacts.
pendingratio Integer The number of contacts that soft bounced from the email over the total number of selected contacts.
contactslostratio Integer The number of contacts that were selected but not sent to over the total number of selected contacts.

 

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/marketing-emails/v1/emails/with-statistics/7563113344?hapikey=demo Example Stats Object: { "ab": false, "abHoursToWait": 1, "abSampleSizeDefault": null, "abSamplingDefault": null, "abSuccessMetric": null, "abTestPercentage": 10, "abVariation": false, "absoluteUrl": "https://developers.hubspot.com/-temporary-slug-50bdd82b-eb88-45e3-a856-1229d78af5cc", "allEmailCampaignIds": [ 70998294 ], "analyticsPageId": "5681632699", "analyticsPageType": "email", "archived": false, "authorAt": 1553173253697, "authorName": "Hubspot System", "authorUserId": 100, "blogEmailType": "daily", "blogRssSettings": { "blog_layout": "SUMMARY_NO_FEATURED_IMAGE" }, "canSpamSettingsId": 1392522301, "categoryId": 2, "contentTypeCategory": 2, "createPage": false, "created": 1522850739920, "createdById": 4488275, "currentState": "BLOG_EMAIL_PUBLISHED", "currentlyPublished": true, "customReplyTo": "", "customReplyToEnabled": false, "domain": "", "emailBody": "{% content_attribute \"email_body\" %}{{ default_email_body }}{% end_content_attribute %}", "emailNote": "", "emailTemplateMode": "DESIGN_MANAGER", "emailType": "BLOG_EMAIL", "emailbodyPlaintext": "", "feedbackEmailCategory": null, "feedbackSurveyId": null, "flexAreas": {}, "freezeDate": 1553173253355, "fromName": "HubSpot", "hsEmailBody": "

Hi {{contact.firstname}},

Describe what you have to offer the customer. Why should they read? What did you promise them in the subject line? Tell them something cool. Make them laugh. Make them cry. Well, maybe don't do that...

Use a list to:

  • Explain the value of your offer
  • Remind the reader what they’ll get out of taking action
  • Show off your skill with bullet points
  • Make your content easy to scan

LINK TO A LANDING PAGE ON YOUR SITE (This is the really important part.)

Now wrap it all up with a pithy little reminder of how much you love them.

Aw. You silver-tongued devil, you.

Sincerely,

Your name

", "htmlTitle": "", "id": 5681632699, "isGraymailSuppressionEnabled": false, "isLocalTimezoneSend": false, "isPublished": true, "isRecipientFatigueSuppressionEnabled": null, "layoutSections": {}, "leadFlowId": null, "liveDomain": "developers.hubspot.com", "mailingListsExcluded": [], "mailingListsIncluded": [ 512 ], "maxRssEntries": 50, "metaDescription": "", "name": "Daily notification email for blog \"HubSpot API Changelog\"", "pageExpiryEnabled": false, "pageRedirected": false, "pastMabExperimentIds": [], "portalId": 428357, "previewKey": "yppwQLUF", "primaryEmailCampaignId": 70998294, "primaryRichTextModuleHtml": "

Hi {{contact.firstname}},

Describe what you have to offer the customer. Why should they read? What did you promise them in the subject line? Tell them something cool. Make them laugh. Make them cry. Well, maybe don't do that...

Use a list to:

  • Explain the value of your offer
  • Remind the reader what they’ll get out of taking action
  • Show off your skill with bullet points
  • Make your content easy to scan

LINK TO A LANDING PAGE ON YOUR SITE (This is the really important part.)

Now wrap it all up with a pithy little reminder of how much you love them.

Aw. You silver-tongued devil, you.

Sincerely,

Your name

", "processingStatus": "", "publishDate": 1553173253529, "publishedAt": 1552679077698, "publishedById": 1230836, "publishedUrl": "https://developers.hubspot.com/-temporary-slug-50bdd82b-eb88-45e3-a856-1229d78af5cc", "replyTo": "noreply@hubspot.com", "resolvedDomain": "developers.hubspot.com", "rssEmailAuthorLineTemplate": "By {{post.author}}, ", "rssEmailBlogImageMaxWidth": 0, "rssEmailByText": "By", "rssEmailClickThroughText": "Read more »", "rssEmailCommentText": "Comment »", "rssEmailEntryTemplate": "

 

{{post.title}}

{{post.publish_date}}

{{post.summary}}

read more »

", "rssEmailEntryTemplateEnabled": true, "rssEmailImageMaxWidth": 0, "rssEmailUrl": "", "rssToEmailTiming": { "repeats": "daily", "repeats_on_monthly": 1, "repeats_on_weekly": 1, "summary": "Daily", "time": "9:00 am" }, "rssUrl": "", "selected": 30, "slug": "-temporary-slug-50bdd82b-eb88-45e3-a856-1229d78af5cc", "smartEmailFields": {}, "state": "BLOG_EMAIL_PUBLISHED", "stats": { "counters": { "sent": 30, "open": 15, "delivered": 30, "bounce": 0, "unsubscribed": 0, "click": 7, "dropped": 1, "selected": 31, "spamreport": 0, "suppressed": 0, "hardbounced": 0, "softbounced": 0, "pending": 0, "contactslost": 0, "notsent": 1 }, "deviceBreakdown": { "open_device_type": { "computer": 7, "mobile": 0, "unknown": 8 }, "click_device_type": { "computer": 7, "mobile": 0, "unknown": 0 } }, "failedToLoad": false, "qualifierStats": {}, "ratios": { "clickratio": 23.333, "clickthroughratio": 46.667, "deliveredratio": 100, "openratio": 50, "unsubscribedratio": 0, "spamreportratio": 0, "bounceratio": 0, "hardbounceratio": 0, "softbounceratio": 0, "contactslostratio": 0, "pendingratio": 0, "notsentratio": 3.226 } }, "styleSettings": null, "subcategory": "blog_email", "subject": "Today's HubSpot API Changelog Updates", "subscription": 4768177, "subscriptionBlogId": 5681771488, "subscriptionName": "HubSpot API Changelog Subscription", "teamPerms": [], "templatePath": "generated_layouts/5718044451.html", "transactional": false, "unpublishedAt": 0, "updated": 1553173253697, "updatedById": 100, "url": "https://developers.hubspot.com/-temporary-slug-50bdd82b-eb88-45e3-a856-1229d78af5cc", "useRssHeadlineAsSubject": false, "userPerms": [], "vidsExcluded": [], "vidsIncluded": [], "widgets": { "column1": { "body": { "html": "" }, "child_css": {}, "css": {}, "id": "column1", "label": "Column Above Body", "name": "column1", "smart_type": null, "type": "rich_text" }, "hs_email_body": { "body": { "html": "

Hi {{contact.firstname}},

Describe what you have to offer the customer. Why should they read? What did you promise them in the subject line? Tell them something cool. Make them laugh. Make them cry. Well, maybe don't do that...

Use a list to:

  • Explain the value of your offer
  • Remind the reader what they’ll get out of taking action
  • Show off your skill with bullet points
  • Make your content easy to scan

LINK TO A LANDING PAGE ON YOUR SITE (This is the really important part.)

Now wrap it all up with a pithy little reminder of how much you love them.

Aw. You silver-tongued devil, you.

Sincerely,

Your name

" }, "child_css": {}, "css": {}, "id": "hs_email_body", "label": "Main Email Body", "name": "hs_email_body", "smart_type": null, "type": "rich_text" }, "logo_image": { "body": { "alt": "HubSpot Developers", "height": 87, "img_alt": "hubspot developers email header.png", "img_load_error": false, "link": "http://developers.hubspot.com", "open_in_new_tab": false, "original_height": 184, "original_width": 1276, "override_inherited_src": true, "src": "https://cdn2.hubspot.net/hubfs/428357/hubspot%20developers%20email%20header.png", "suppress_company_name": false, "width": 603 }, "child_css": {}, "css": {}, "id": "logo_image", "label": "Logo", "name": "logo_image", "smart_type": null, "type": "logo" }, "preview_text": { "body": { "value": "" }, "child_css": {}, "css": {}, "id": "preview_text", "label": "Preview Text This will be used as the preview text that displays in some email clients", "name": "preview_text", "smart_type": null, "type": "text" } } }