HubSpot API Data Model
MarketingCampaignsByCampaignGuid |
Read a campaignGet a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.
Catalog: Campaigns
Schema: Basic
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 MarketingCampaignsByCampaignGuid. 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 |
|---|---|---|---|---|
campaignGuid |
|
☑ |
|
The UUID of the campaign, requiredExample: 9dbec438-53e2-4b28-8c0f-38f56574a6e8 |
endDate |
|
☐ |
|
The end date for fetching asset metrics, in YYYY-MM-DD format.Optional. Example: 2000-01-27 |
startDate |
|
☐ |
|
The start date for fetching asset metrics, in YYYY-MM-DD format. Optional. Example: 2000-01-20 |
Columns of Table Function
The columns of the table function MarketingCampaignsByCampaignGuid are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
assets |
varchar2 |
|
☐ |
Contains the assets associated with the campaign, each represented as a collection of campaign assets. |
createdAt |
datetime |
Created at |
☐ |
The date and time when the campaign was created, formatted as a date-time string. |
id |
varchar2 |
ID |
☐ |
The unique identifier for the campaign. |
properties |
varchar2 |
Properties |
☐ |
A map of key-value pairs representing the properties of the campaign. |
updatedAt |
datetime |
Updated at |
☐ |
The date and time when the campaign was last updated, formatted as a date-time string. |
