Retrieve events by subscription id
This method allows you to retrieve events associated with a specific subscriptionId.
It offers an optional query parameter locale that returns the event name and description for the specified locale id. Contact support@possiblenow.com with localized names and description for locales you want to use. If the localized name and description is not configured for the specified locale, the API will return the event name and description in your account's default locale. A future update will provide an API for programmatic management of these updates.
The startAt parameter must be set before endAt and should not exceed the MaxEventHistoryDays setting of 15 days. If the startAt parameter is not specified, the API defaults it to MaxEventHistoryDays.
All API users must have the Event Data - > View Permission enabled within their User Groups.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
Optional parameter used for returning the event name and description in the specified locale. If not supplied, the client's default locale will be used.
Optional parameter used to limit the events returned to a specific event type.
Optional datetime. Events created before this datetime will not be returned.
Optional datetime. Events created after this datetime will not be returned.
Collection of Source Group IDs specified as an indexed array.
Show child attributes
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
This is the value that uniquely identifies the subscription for which the events are being retrieved for.
Response
Response Attributes
System-generated identifier that uniquely identifies an event.
Represents the type of action that occured. It's synonymous with an event.
An allocated field within the event data structure, reserved for advanced event filtering for routing purposes.
Name of the entity associated with the event.
Uniquely identifies the subscription for which the events are being retrieved for
Name of the event.
Description of the event.
This is the value that uniquely identifies the profile for which the events are being retrieved.
Data pertaining to a particular event. It is encapsulated as a nested object with its individual key-value pairs within the Events JSON structure.
Show child attributes
The date and time when the event occurred.
The date and time when the event was queued for distribution.
The date and time the event was recorded in the system.
The name of the user who recorded the event.