MarketingCampaignAssetsByCampaignGuidAndAssetType |
List assetsThis endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type.Asset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.
Catalog: CampaignsPublicApi3
Schema: Asset
Label: {res:itgen_hubspot_marketingcampaignassetsbycampaignguidandassettype_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 MarketingCampaignAssetsByCampaignGuidAndAssetType. 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 |
☐ |
|
A cursor for pagination. If provided, the results will start after the given cursor.Example: NTI1Cg%3D%3D |
assetType |
string |
☑ |
|
The type of asset to fetch. |
campaignGuid |
string |
☑ |
|
Unique identifier for the campaign, formatted as a UUID. |
endDate |
string |
☐ |
|
End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.If not provided, no asset metrics will be fetched. |
startDate |
string |
☐ |
|
Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.If not provided, no asset metrics will be fetched. |
Columns of Table Function
The columns of the table function MarketingCampaignAssetsByCampaignGuidAndAssetType are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
id |
string |
ID |
☐ |
|
metrics |
string |
{res:itgen_hubspot_metrics} |
☐ |
|
name |
string |
Name |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180