API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve events by profile id

This method allows you to retrieve events for a specific profile. It is designed to facilitate customer experiences that display recent actions performed by an individual on their profile.

It provides a range of optional query parameters, enabling you to filter events based on a specific event type, the source capturing the event, the event's date and time, and the locale.

EventType: Returns events for the specified event type. Example: EventType=profile.deleted.

StartAt and EndAt: Returns events for the dates specified.

  • Including StartAt returns events equal to or greater than than the provided date.
  • Including EndAt returns events equal to or less than the provided date.
  • If both values are provided, the search will return the events between the specified values. If both values are not provided, the search is inclusive of all dates.

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.

SourceGroupIds: Returns events for the specified Source Group Id's. Use this parameter if you are interested in receiving events that were recorded by a specific data source. Example: Cookie Preference Center.

Locale: Returns the event name and description in the specified locale. Contact support@possiblenow.com with the list of localized names and description for locales you want to use. A future update will provide an API for programmatic management of these updates.

All API users must have the Event Data - > View Permission enabled within their User Groups.

Sample Events Request

The sample below illustrates an events retrieval request for a profile Id. The results are returned based on the events associated with the profile and also account for any optional query parameters specified.

Plain text

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Type of the data being sent in the request or the data that is expected in the response. Supports application/json.

Query Parameters

eventTypestring

Optional parameter used to limit the events returned to a single type.

startAtstring

Optional datetime. Events created before this datetime will not be returned.

endAtstring

Optional datetime. Events created after this datetime will not be returned.

sourceGroupIdsarray

Collection of Source Group IDs specified as an indexed array.

Show child attributes

localestring

Optional parameter used for returning the event name and description in the specified locale. If not specified, the default locale assigned to your MyPreferences account will be used.

subscribedOnlyboolean

Optional parameter that when set to true only returns events that are associated with an active subscription. Defaults to true.

Path Parameters

clientIdstring

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

ProfileIdstring

This is the value that uniquely identifies the profile for which the events are being retrieved.

Response

200
Object
The request was successfully processed.

Response Attributes

EventIdstring

System-generated identifier that uniquely identifies an event.

EventTypestring

Represents the type of action that occured. It's synonymous with an event.

Subjectstring

An allocated field within the event data structure, reserved for advanced event filtering for routing purposes.

Entitystring

Name of the entity associated with the event.

SubscriptionIdinteger

Uniquely identifies the subscription for which the events are being retrieved for

Namestring

Name of the event.

Descriptionstring

Description of the event.

ProfileIdinteger

This is the value that uniquely identifies the profile for which the events are being retrieved.

Dataobject

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

OriginalEventTimestring

The date and time when the event occurred.

EventTimestring

The date and time of the event generation.

CreateDatestring

The date and time the event was recorded in the system.

CreatedBystring

The name of the user who recorded the event.

204
Object
No Content
400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.

Response Attributes

Messagestring
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?