HubSpot API Data Model
MarketingCampaignBudgetTotalItemsByCampaignGuid |
Read budgetRetrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget.Budget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer
Catalog: Campaigns
Schema: Budget
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 MarketingCampaignBudgetTotalItemsByCampaignGuid. 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 |
Columns of Table Function
The columns of the table function MarketingCampaignBudgetTotalItemsByCampaignGuid are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
amount |
decimal |
|
☐ |
The monetary amount allocated for the budget item. |
budgetTotal |
decimal |
|
☐ |
The total budget allocated for the campaign. |
createdAt |
int64 |
Created at |
☐ |
The timestamp when the budget item was created. |
currencyCode |
varchar2 |
Currency Code |
☐ |
The currency code used for the budget and spend amounts, following ISO 4217 standards. |
description |
varchar2 |
Description |
☐ |
A description of the budget item. |
id |
varchar2 |
ID |
☐ |
The unique identifier for the budget item. |
name |
varchar2 |
Name |
☐ |
The name of the budget item. |
order |
int32 |
Order |
☐ |
The order of the budget item, indicating its sequence based on creation date. |
remainingBudget |
decimal |
|
☐ |
The remaining budget available for the campaign after accounting for all spend items. |
spendTotal |
decimal |
|
☐ |
The total amount spent across all spend items in the campaign. |
updatedAt |
int64 |
Updated at |
☐ |
The timestamp when the budget item was last updated. |
