Event Analytics endpoint allows you to find and filter events associated with a CRM object of any type.
objectType
and including either the objectId
or objectProperty
query parameter.
objectId
query parameter. For example, to specify a contact record with the ID of 2832, you would make the following GET
request:
/events/v3/events/?objectType=contact&objectId=224834
objectProperty
parameter. Reference the property by including the property name and the value in the following format:
objectProperty.{propname}={propvalue}
For example, to specify a contact by their email address, you would make the following GET
request:
/events/v3/events/?objectType=contact&objectProperty.email=user12@dev.com
eventType
parameter, followed by the event name. To get a list of all available event types, you can make a GET
request to /events/v3/events/event-types
. The response will return all event types in your account. You can then use one of these event names as a query parameter in a GET
request to the /events/v3/events
endpoint.
For example:
/events/v3/events/eventType={EVENT_NAME}&objectType=contact&objectId=224834