Get email events

GET /email/public/v1/events

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Query the event log for events matching specified parameters.

Note that events will be returned in reverse-chronological order.

Pagination

The parameters offset and limit are used to paginate results.

The returned offset is an opaque token used internally to keep track of the position in the result set. It is not meant to be used for anything other than subsequent requests on this endpoint with the same query parameters (excluding offset itself and limit). Further, it is not meant to be long-lived.

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.
Optional Parameters How to use Description
HubSpot App ID appId=X - Used in the request URL Only return events which correspond to the given HubSpot Application ID.
HubSpot Campaign ID campaignId=X - Used in the request URL Only return events from the given HubSpot Campaign ID.
Recipient Email Address recipient=X - Used in the request URL Only return events related to the given recipient.
Event Type eventType=X - Used in the request URL Only return events of the specified type (case-sensitive). The possible types are described in the Email Events Bible.
Start Timestamp startTimestamp=X - Used in the request URL Only return events which occurred at or after the given timestamp (in milliseconds since epoch).
End Timestamp endTimestamp=X - Used in the request URL Only return events which occurred at or before the given timestamp (in milliseconds since epoch).
Offset offset=X - Used in the request URL An offset token returned by a previous call to this endpoint.
Limit limit=X - Used in the request URL The maximum number of events to return. If omitted, the default value of 10 is used. The maximum allowed value is 1000.

Example URL:  https://api.hubapi.com/email/public/v1/events?hapikey=demo&campaignId=13054799&appId=20185

Refer to the Email Events Overview for a full description of events, including the different event types, what they represent, how they're related, and their properties.