EmailCampaignEvents
The events associated with an email campaign or a recipient.
Table Specific Information
Email campaign events represent individual events that occurred during an email campaign. These are generally events such as a contact clicking on a link that was included in the email.
Select
Email campaign events may be filtered by RecipientEmail, AppId, CampaignId, Type, and CreatedAt. Email campaign events can also be retrieved one at a time by specifying both the Id and CreatedAt, but the CreatedAt datetime will need to be correct to the millisecond. For example:
SELECT * FROM EmailCampaignEvents SELECT * FROM EmailCampaignEvents WHERE CreatedAt='9/23/2014 5:28:00.280 PM' AND Id='123456789' SELECT * FROM EmailCampaignEvents WHERE CampaignId='14229773' AND AppId = '113' AND Type='CLICK' AND CreatedAt > '9/23/2014 1:28:00 PM' AND CreatedAt < '9/23/2014 7:29:00 PM'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the email campaign event. | |
| CampaignId | String | Campaign id of the email campaign associated with the event. | |
| Type | String | The type of event.
The allowed values are SENT, DROPPED, PROCESSED, DELIVERED, DEFERRED, BOUNCE, OPEN, CLICK, PRINT, FORWARD, STATUSCHANGE, SPAMREPORT. | |
| RecipientEmail | String | Email address of the recipient associated with the event. | |
| PortalId | Long | An ID referencing the HubSpot account that sent the email message. This will correspond to your account. | |
| AppId | Long | An Id referencing the HubSpot Application which sent the email message. | |
| AppName | String | The name of the HubSpot Application which sent the email message. Note that this is a derived value, and may be modified at any time. | |
| CreatedAt | Datetime | When this event was created. | |
| SentById | String | The Event Id which uniquely identifies the email message's SENT event. | |
| SentByCreatedAt | Datetime | When the email message's SENT event. wich created. | |
| ObsoletedById | String | The EventId which uniquely identifies the follow-on event which makes this current event obsolete. | |
| ObsoletedByCreatedAt | Datetime | When the event which obsoleted the current event was created. | |
| CausedById | String | The EventId which uniquely identifies the event which directly caused this event. | |
| CausedByCreatedAt | Datetime | When the event which caused the current event was created. | |
| Subject | String | The subject line of the email message. | |
| From | String | The 'from' field of the email message. | |
| ReplyTo | String | The 'reply-to' field of the email message. | |
| Cc | String | The 'cc' field of the email message. | |
| Bcc | String | The 'bcc' field of the email message. | |
| DropReason | String | The reason why the email message was dropped.
The allowed values are PREVIOUSLY_BOUNCED, PREVIOUS_SPAM, PREVIOUSLY_UNSUBSCRIBED_MESSAGE, PREVIOUSLY_UNSUBSCRIBED_PORTAL, INVALID_TO_ADDRESS, INVALID_FROM_ADDRESS, BLOCKED_DOMAIN, BLOCKED_ADDRESS, EMAIL_UNCONFIRMED, CAMPAIGN_CANCELLED, MTA_IGNORE, PORTAL_OVER_LIMIT, PORTAL_SUSPENDED. | |
| DropMessage | String | The raw message describing why the email message was dropped. This will usually provide additional details beyond 'dropReason'. | |
| Category | String | The best-guess of the type of bounce encountered. If an appropriate category couldn't be determined, this property is omitted.
The allowed values are UNKNOWN_USER, MAILBOX_FULL, CONTENT, SPAM, POLICY, GREYLISTING, MAILBOX_MISCONFIGURATION, ISP_MISCONFIGURATION, DOMAIN_REPUTATION, DMARC, SENDING_DOMAIN_MISCONFIGURATION, TIMEOUT, THROTTLED, UNCATEGORIZED, IP_REPUTATION, DNS_FAILURE, TEMPORARY_PROBLEM. | |
| Response | String | The full response from the recipient's email server. | |
| SmtpId | String | An ID attached to the message by HubSpot. | |
| Attempt | Integer | The delivery attempt number. | |
| Status | String | The status code returned from the recipient's email server. | |
| DeviceType | String | The type of device used that triggered the event if avialable. | |
| HMID | String | A randomly-generated Id which corresponds to the header 'X-HubSpot-MID' in the email message. | |
| Referer | String | The URL of the webpage that linked to the URL clicked. Whether this is provided, and what its value is, is determined by the recipient's email client. | |
| Url | String | The URL within the message that the recipient clicked. | |
| UserAgent | String | The user agent responsible for the event. | |
| BrowserFamily | String | The family of the browser that serviced the event. | |
| BrowserName | String | The name of browser that serviced the event. | |
| BrowserProducer | String | The producer of browser that serviced the event. | |
| BrowserProducerUrl | String | A url to the producer of the browser if available. | |
| BrowserType | String | The type of browser that produced the event. | |
| BrowserUrl | String | A url to an entry describing the browser if available. | |
| BrowserVersion | String | The versionof browser used. | |
| LocationCity | String | The city where the event occurred. | |
| LocationCountry | String | The country where the event occurred. | |
| LocationState | String | The state where the event occurred. | |
| FilteredEvent | Boolean | A boolean representing whether the event has been filtered out of reporting based on customer reports settings or not. | |
| Source | String | The source of the subscription change.
The allowed values are SOURCE_LIST_UNSUBSCRIBE, SOURCE_RECIPIENT, SOURCE_IMPORT, SOURCE_HUBSPOT_CUSTOMER, SOURCE_SPAM_REPORT, SOURCE_NON_DELIVERY_REPORT, SOURCE_DIRECT_COMPLAINT, SOURCE_MTA_RECORD, SOURCE_HUBSPOT, SOURCE_MIGRATION, SOURCE_HUBSPOT_CLEANUP, SOURCE_KNOWN_SPAM_TRAP. | |
| RequestedBy | String | The email address of the person requesting the change on behalf of the recipient. | |
| Subscriptions | String | The status of subscriptions for the recipient. | |
| PortalSubscriptionStatus | String | The recipient's portal subscription status.
The allowed values are SUBSCRIBED, UNSUBSCRIBED. | |
| ExtraUrlParameters | String | An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'. |