View subscriptions timeline for a portal

GET /email/public/v1/subscriptions/timeline

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

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 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
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?hapikey=demo