View subscriptions timeline for a portal | Email API

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing

Required Scope:

For a given portal, return a time-ordered list of subscription changes.

Notes on the API

Timeline items will be returned in reverse-chronological order.
Query parameters offset and limit are used to paginate results.
The returned property 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. Further, it is not meant to be long-lived.

Required Parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters	How to use	Description
Change Type	changeType=X - Used in the request URL	Only return timeline changes of the specified type (case-sensitive). The possible types are described in the Email Subscriptions Bible.
Start Timestamp	startTimestamp=X - Used in the request URL	Only return timeline items which occurred at or after the given timestamp (in milliseconds since epoch).
End Timestamp	endTimestamp=X - Used in the request URL	Only return timeline items which occurred at or before the given timestamp (in milliseconds since epoch).
Include Snapshots	includeSnapshots=X - Used in the request URL	Include the user's full subscription snapshot with each timeline item. This snapshot is equivalent to what this endpoint would have returned at that time.
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 timeline items to return. If omitted, the default value of `10` is used. The maximum allowed value is `1000`.

Example URL: http://api.hubapi.com/email/public/v1/subscriptions/timeline

JSON

{ "hasMore": true, "offset": "CK_PuKu3KBXr8LqG", "timeline": [ { "timestamp": 1401975207000, "portalId": 62515, "recipient": "6d4b537e-c5ac-11e3-a673-00262df65d03@some.email.com", "changes": [ { "change": "BOUNCED", "source": "SOURCE_NON_DELIVERY_REPORT", "portalId": 62515, "changeType": "PORTAL_BOUNCE", "causedByEvent": { "id": "6d72d39c-87da-3ced-bfdf-5f0213363827", "created": 1401975207000 } } ] }, { "timestamp": 1400255007763, "portalId": 62515, "recipient": "tim@opas.com", "changes": [ { "change": "SUBSCRIBED", "source": "SOURCE_RECIPIENT", "portalId": 62515, "subscriptionId": 2849, "changeType": "SUBSCRIPTION_STATUS", "causedByEvent": { "id": "0d813e2c-ce7f-4510-9250-839cd08c967a", "created": 1400255007763 } }, { "change": "SUBSCRIBED", "source": "SOURCE_RECIPIENT", "portalId": 62515, "subscriptionId": 230318, "changeType": "SUBSCRIPTION_STATUS", "causedByEvent": { "id": "0d813e2c-ce7f-4510-9250-839cd08c967a", "created": 1400255007763 } }, { "change": "SUBSCRIBED", "source": "SOURCE_RECIPIENT", "portalId": 62515, "changeType": "PORTAL_STATUS", "causedByEvent": { "id": "0d813e2c-ce7f-4510-9250-839cd08c967a", "created": 1400255007763 } } ] }, { "timestamp": 1399053958000, "portalId": 62515, "recipient": "testemail+535fe913a51ff@emailtest.com", "changes": [ { "change": "BOUNCED", "source": "SOURCE_NON_DELIVERY_REPORT", "portalId": 62515, "changeType": "PORTAL_BOUNCE", "causedByEvent": { "id": "cf568063-f12f-3a94-9c02-faccdc5f9bad", "created": 1399053958000 } } ] }, ... ] }