WebAnalytics
The Web Analytics endpoint allows developers to find and filter events associated with a CRM object of any type.
View Specific Information
SELECT
EventType, or ObjectType and either ObjectId or ObjectProperty must be specified.
When selecting WebAnalytics, they can only be filtered by the EventType, ObjectType, ObjectId, ObjectProperty, OccurredAfter, OccurredBefore and Sort. For example:
SELECT * FROM WebAnalytics WHERE ObjectId = '74924128' AND ObjectType = 'contact' SELECT * FROM WebAnalytics WHERE ObjectId = '101' AND ObjectType = 'contact' AND OccurredAfter = '07/02/2020 09:45:50.829' SELECT * FROM WebAnalytics WHERE ObjectId = '101' AND ObjectType = 'contact' AND OccurredBefore = '07/02/2020 09:45:50.829' SELECT * FROM WebAnalytics WHERE ObjectId = '101' AND ObjectType = 'contact' AND Sort = 'occurredAt'
Columns
Name | Type | References | Filterable | Description |
Id [KEY] | String | False | Id of the event. | |
ObjectId | String | False | Id of the object. | |
ObjectType | String | False | Type of the selected object. | |
EventType | String | False | Type of the event. | |
OccurredAt | Datetime | False | Time when the event occurred. | |
Properties | String | False | Additional properties. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.
Name | Type | Description | |
ObjectProperty | String | If the id of the selected object not present_ then the objectProperty parameter is required. A particular property to match on is identified by an objectProperty._propname___propvalue_ query parameter. To find contacts by their email property you have to specify the value of the ObjectProperty in this format _ 'propertyName_propertyValue' | |
OccurredAfter | Datetime | The starting time as an ISO 8601 timestamp. | |
OccurredBefore | Datetime | The ending time as an ISO 8601 timestamp. | |
Sort | String | Selects the sort field and order. Defaults to ascending_ prefix with _ for descending order. 'occurredAt' is the only field supported for sorting. |