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.
RecipientEmail	String		Email address of the recipient associated with the event.
CampaignId	Long	EmailCampaigns.Id	Campaign id of the email campaign associated with the event.
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.
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.
IPAddress	String		The IP address where the event originated.
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.
Type	String		The type of event. The allowed values are SENT, DROPPED, PROCESSED, DELIVERED, DEFERRED, BOUNC, OPEN, CLICK, PRINT, FORWARD, STATUSCHANGE, SPAMREPORT.
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.
SentByCreatedAt	Datetime		When the email was sent.
SentById	String		The Id which uniquely identifies the email message's SENT event.
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'.