HubSpot API Data Model
MarketingEventParticipationContactBreakdownsByContactId |
Read participations breakdown by Contact identifierRead Contact's participations by identifier - email or internal id.
Catalog: MarketingEvents
Schema: ParticipantState
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 MarketingEventParticipationContactBreakdownsByContactId. 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 |
|
☐ |
|
The cursor indicating the position of the last retrieved item. |
contactIdentifier |
|
☑ |
|
The identifier of the Contact. It may be email or internal id. |
state |
|
☐ |
|
The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW |
Columns of Table Function
The columns of the table function MarketingEventParticipationContactBreakdownsByContactId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
associations_contact_contactId |
varchar2 |
|
☐ |
The internal ID of the contact in HubSpot |
associations_contact_email |
varchar2 |
|
☐ |
The email of the contact in HubSpot |
associations_contact_firstname |
varchar2 |
|
☐ |
The first name of the contact in HubSpot |
associations_contact_lastname |
varchar2 |
|
☐ |
The last name of the contact in HubSpot |
associations_marketingEvent_externalAccountId |
varchar2 |
|
☐ |
The account ID that is associated with this marketing event in the external event application |
associations_marketingEvent_externalEventId |
varchar2 |
|
☐ |
The event ID that is associated with this marketing event in the external event application |
associations_marketingEvent_marketingEventId |
varchar2 |
|
☐ |
The internal ID of the marketing event in HubSpot |
associations_marketingEvent_name |
varchar2 |
|
☐ |
The name of the marketing event in HubSpot |
createdAt |
datetime |
Created at |
☐ |
The creation time and date of the target marketing event |
id |
varchar2 |
ID |
☐ |
The internal ID of the target marketing event |
properties_attendanceDurationSeconds |
int32 |
|
☐ |
The number of seconds the participation lasted |
properties_attendancePercentage |
varchar2 |
|
☐ |
Percentage of the participation duration relative to the event duration |
properties_attendanceState |
varchar2 |
|
☐ |
The state of the participation |
properties_occurredAt |
int64 |
|
☐ |
Timestamp of when the participation occurred |
