MarketingEventsSearchByQuery |
Find App-Specific Marketing Events by External Event IdRetrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request.Marketing Events created by other apps will not be included in the results.
Catalog: MarketingEvents3
Schema: Identifiers
Label: {res:itgen_hubspot_marketingeventssearchbyquery_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 MarketingEventsSearchByQuery. 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 |
---|---|---|---|---|
q |
string |
☑ |
|
The id of the marketing event in the external event application (externalEventId) |
Columns of Table Function
The columns of the table function MarketingEventsSearchByQuery are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
appId |
int32 |
App ID |
☐ |
|
externalAccountId |
string |
External Account ID |
☐ |
|
externalEventId |
string |
External Event ID |
☐ |
|
objectId |
string |
Object ID |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180