GET
/
marketing-emails
/
v1
/
emails
/
with-statistics
Get the statistics of all marketing emails
curl --request GET \
  --url https://api.hubapi.com/marketing-emails/v1/emails/with-statistics \
  --header 'Authorization: Bearer <token>'
{
  "limit": 123,
  "objects": [
    {
      "ab": true,
      "abHoursToWait": 123,
      "abTestPercentage": 123,
      "abVariation": true,
      "absoluteUrl": "<string>",
      "allEmailCampaignIds": [
        123
      ],
      "analyticsPageId": "<string>",
      "analyticsPageType": "<string>",
      "archived": true,
      "author": "<string>",
      "authorAt": 123,
      "authorEmail": "<string>",
      "authorName": "<string>",
      "authorUserId": 123,
      "campaign": "<string>",
      "campaignName": "<string>",
      "campaignUtm": "<string>",
      "canSpamSettingsId": 123,
      "categoryId": 123,
      "contentTypeCategory": 123,
      "created": 123,
      "createdById": 123,
      "currentState": "<string>",
      "currentlyPublished": true,
      "domain": "<string>",
      "emailBody": "<string>",
      "emailNote": "<string>",
      "emailTemplateMode": "<string>",
      "emailType": "<string>",
      "emailbodyPlaintext": "<string>",
      "freezeDate": 123,
      "fromName": "<string>",
      "htmlTitle": "<string>",
      "id": 123,
      "isGraymailSuppressionEnabled": true,
      "isLocalTimezoneeSend": true,
      "isPublished": true,
      "isRecipientFatigueSuppressionEnabled": true,
      "lastEditSessionId": 123,
      "lastEditUpdateId": 123,
      "layoutSections": {},
      "leadFlowId": 123,
      "liveDomain": "<string>",
      "mailingListsExcluded": [
        123
      ],
      "mailingListsIncluded": [
        123
      ],
      "maxRssEntries": 123,
      "metaDescription": "<string>",
      "name": "<string>",
      "pageExpiryEnabled": true,
      "pageRedirected": true,
      "portalId": 123,
      "previewKey": "<string>",
      "processingStatus": "<string>",
      "publishDate": 123,
      "publishImmediately": true,
      "publishedUrl": "<string>",
      "replyTo": "<string>",
      "resolvedDomain": "<string>",
      "rssEmailByText": "<string>",
      "rssEmailClickThroughText": "<string>",
      "rssEmailCommentText": "<string>",
      "rssEmailEntryTemplateEnabled": true,
      "rssEmailImageMaxWidth": 123,
      "rssEmailUrl": "<string>",
      "slug": "<string>",
      "smartEmailFields": {},
      "state": "<string>",
      "styleSettings": {},
      "subcategory": "<string>",
      "subject": "<string>",
      "subscription": 123,
      "subscriptionName": "<string>",
      "teamPerms": [
        "<string>"
      ],
      "templatePath": "<string>",
      "transactional": true,
      "unpublishedAt": 123,
      "updated": 123,
      "updatedById": 123,
      "url": "<string>",
      "useRssHeadlineAsSubject": true,
      "userPerms": [
        "<string>"
      ],
      "vidsExcluded": [
        123
      ],
      "vidsIncluded": [
        123
      ],
      "widgets": {},
      "stats": {
        "counters": {
          "sent": 123,
          "open": 123,
          "delivered": 123,
          "bounce": 123,
          "unsubscribed": 123,
          "click": 123,
          "dropped": 123,
          "selected": 123,
          "spamreport": 123,
          "suppressed": 123,
          "hardbounced": 123,
          "softbounced": 123,
          "pending": 123,
          "contactslost": 123,
          "notsent": 123
        },
        "deviceBreakdown": {
          "open_device_type": {
            "computer": 123,
            "mobile": 123,
            "unknown": 123
          },
          "click_device_type": {
            "computer": 123,
            "mobile": 123,
            "unknown": 123
          }
        },
        "failedToLoad": true,
        "qualifierStats": {},
        "ratios": {
          "clickratio": 123,
          "clickthroughratio": 123,
          "deliveredratio": 123,
          "openratio": 123,
          "unsubscribedratio": 123,
          "spamreportratio": 123,
          "bounceratio": 123,
          "hardbounceratio": 123,
          "softbounceratio": 123,
          "contactslostratio": 123,
          "pendingratio": 123,
          "notsentratio": 123
        }
      }
    }
  ],
  "offset": 123,
  "total": 123,
  "totalCount": 123
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit
integer
default:10

The number of records to return in the response. Defaults to 10

offset
integer

Used to get the next page of results. Use the limit of the previous request as the offset to get the next set of results.

orderBy
string

Return the emails ordered by a particular field value. Use a negative value to sort in descending order (e.g. orderBy=-created).

Response

200
application/json

List of marketing emails with statistics

The response is of type object.