HubSpot API Data Model
EventByEventTypeOrObjectType |
Event Instance QueryThis endpoint allows you to query for event instances using filter criteria.
Catalog: Events3
Schema: Events
Label: {res:itgen_hubspot_eventbyeventtypeorobjecttype_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function EventByEventTypeOrObjectType. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
after |
string |
☐ |
|
The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. |
before |
string |
☐ |
|
|
eventType |
string |
☐ |
|
The event type name. A list of available event type names can be obtained from another API call. |
objectId |
int64 |
☐ |
|
The ID of the CRM Object to filter event instances on. If filtering on objectId, you must also provide an objectType. |
objectType |
string |
☐ |
|
The CRM Object type name to filter event instances on. Optionally, you can also provide an objectId in another param to filter to a specific CRM Object instance. |
occurredAfter |
datetime |
☐ |
|
|
occurredBefore |
datetime |
☐ |
|
|
Columns of Table Function
The columns of the table function EventByEventTypeOrObjectType are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
eventType |
string |
Event Type |
☐ |
The format of the `eventType` string is `ae{appId}_{eventTypeLabel}`, `pe{portalId}_{eventTypeLabel}`, or just `e_{eventTypeLabel}` for HubSpot events. |
id |
string |
ID |
☐ |
A unique identifier for the event. |
objectId |
string |
Object ID |
☐ |
The objectId of the object which did the event. |
objectType |
string |
Object Type |
☐ |
The objectType for the object which did the event. |
occurredAt |
datetime |
Occurred at |
☐ |
An ISO 8601 timestamp when the event occurred. |
properties |
string |
Properties |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180
