メインコンテンツへスキップ
GET
/
email
/
public
/
v1
/
events
Get email events
curl --request GET \
  --url https://api.hubapi.com/email/public/v1/events
{
  "events": [
    {
      "appId": 123,
      "appName": "<string>",
      "created": 123,
      "emailCampaignId": 123,
      "id": "<string>",
      "portalId": 123,
      "recipient": "<string>",
      "type": "<string>",
      "browser": {
        "family": "<string>",
        "name": "<string>",
        "producer": "<string>",
        "producerUrl": "<string>",
        "type": "<string>",
        "url": "<string>",
        "version": [
          "<string>"
        ]
      },
      "hmid": "<string>",
      "location": {
        "city": "<string>",
        "country": "<string>",
        "state": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "response": "<string>",
      "sentBy": {
        "created": 123,
        "id": "<string>"
      },
      "sendId": "<string>",
      "smtpId": "<string>",
      "subject": "<string>",
      "userAgent": "<string>"
    }
  ],
  "hasMore": true,
  "offset": "<string>"
}

クエリパラメータ

appId
integer

Only return events which correspond to the given HubSpot Application ID.

campaignId
integer

Only return events from the given HubSpot Campaign ID.

recipient
string

Only return events related to the given recipient.

eventType
string

Only return events of the specified type (case-sensitive).

startTimestamp
integer<int64>

Only return events which occurred at or after the given timestamp (in milliseconds since epoch).

endTimestamp
integer<int64>

Only return events which occurred at or before the given timestamp (in milliseconds since epoch).

offset
string

An offset token returned by a previous call to this endpoint.

limit
integer
デフォルト:10

The maximum number of events to return. If omitted, the default value of 10 is used. The maximum allowed value is 1000.

必須範囲: 1 <= x <= 1000
excludeFilteredEvents
boolean
デフォルト:false

Only return events that have not been filtered out due to customer filtering settings. The default value is false.

レスポンス

Email events retrieved successfully

events
object[]
必須
hasMore
boolean
必須

Whether there are more results available

offset
string
必須

Offset token for pagination

Last modified on April 14, 2026