Cmdlets for HubSpot

Build 24.0.9032

Goals

Retrieve the available Goals in HubSpot.

Columns

Name Type References Filterable Description
Id [KEY] Long True Unique identifier of the object.
Archived Bool False Whether the object is archived or not.
CreatedAt Datetime False When the object was created.
UpdatedAt Datetime False When the object was last updated.
MigrationSoftDeleteDeprecated String True Describes if the goal target can be treated as deleted.
Ad account asset IDs String True A list of ';'-separated universally unique IDs of ad accounts, each formatted: {AD_NETWORK}-{ACCOUNT_ID}
Ad campaign asset ids String True A list of ';'-separated universally unique IDs of ad campaigns, each formatted: {NETWORK}-{CAMPAIGN_ID}
All teams String True The team IDs, including up the team hierarchy, corresponding to all owner referencing properties for this object, both default and custom.
Business units String True The business units this record is assigned to.
All owner ids String True The value of all owner referencing properties for this object, both default and custom.
Team ids String True Which team owns the goal (there should only ever be one team).
Assignee team ID Decimal True The team ID of the assigned team of the goal (unpopulated if the goal is not team-assigned or team-by-user-assigned).
Assignee user ID Decimal True The user ID of the assigned user of the goal (unpopulated if the goal is not user-assigned).
Campaign asset ids String True List of marketing campaign asset ids.
Contact lifecycle stage String True The lifecycle stage selected for the contact lifecycle goal.
Created by user ID Decimal True The user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date/time Datetime True The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
currency String True DEPRECATED - DO NOT USE! Code for the currency conversion.
Currency Exchange Rate Decimal True Exchange rate to be used for calculated properties reflecting currency-based values in home currencies. Value is automatically set for in-progress goals. Once a goal has ended, the value should be alterable by admins only.
Deal pipelines String True A serialized list of DEAL pipeline IDs used to filter the KPI value calculation.
Edit updates notification frequency String True The frequency of goal edit update notifications.
End date Date True The last day covered by the Goal Target's date range.
End datetime Datetime True The last day covered by the Goal Target's date range.
Fiscal year offset Decimal True Represents the number of months the fiscal year is away from a standard calendar year (0 means the fiscal year starts in January).
Goal name String True The name of the goal.
Goal target currency code String True Currency code for the goal target.
Goal Target Group ID Decimal True Object ID of the associated Goal Target Group.
Goal type String True The goal type.
Group correlation UUID String True Unique ID set on all Goal Targets and Goal Target Groups created by a single request.
Is forecastable String True READ ME! (kind of) indicates whether the goal should appear in the forecasting app - this property may be true even if the goal should NOT appear in the forecasting app. As of April 2023, this property will be true if hs_milestone is either \\“monthly\\” or \\“quarterly\\“, and if the count of pipelines in hs_pipelines 0 or 1. No other checks are made!
IsLegacy String True Describes if the object was created during the migration process and it comes from the old app.
KPI Display Unit String True Display units for goals based on duration properties.
KpiFilterGroups String True Filter groups for KPI calculations.
KPI is team rollup Bool True Indicates whether this is a rollup goal: whether the KPI allows contributions from child teams (in addition to the assigned team).
KpiMetricType String True Type of metric used to aggregate the property name.
KpiObjectType String True The name of the CrmObject the KPI values are based on.
Kpi object type id String True The ObjectTypeId of the object the KPI values are based on.
KpiPropertyName String True Name of the property on the object type aggregated as the KPI value.
KpiSingleObjectCustomGoalTypeName String True Single object custom goal components (metric type, object type, property name).
KpiTimePeriodProperty String True Time period property.
KpiTrackingMethod String True Tracking method for progress directionality.
Kpi unit type String True Unit type of the kpi calculation.
KPI value Decimal True The latest KPI value for this goal target.
KPI value calculated at Decimal True The time that latest KPI value was calculated.
KPI value last calculated at Datetime True The time that latest KPI value was calculated.
Object last modified date/time Datetime True Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
LegacyActive String True Migrated value describing if the goal is active or soft deleted.
LegacyCreatedAt Decimal True Migrated value of created at.
LegacyCreatedBy Decimal True Migrated value of created by.
LegacyQuarterlyTargetCompositeId String True Concatenated value of the 3 sql_ids that form a quarterly GT separated by a '-'. Used to be able to update both monthly and quarterly legacy Goal Targets.
LegacySqlId Decimal True Id of the migrated goal target in the old system. This has been deprecated for legacy_unique_sql_id.
LegacyUniqueSqlId Decimal True Id of the migrated goal target in the old system. This property has a unique value to ensure no duplicate migrated goals.
LegacyUpdatedAt Decimal True Migrated value of updated at.
LegacyUpdatedBy Decimal True Migrated value of updated by.
Merged record IDs String True The list of record IDs that have been merged into this record. This value is automatically set by HubSpot and may not be modified.
MigrationSoftDelete String True Describes if the goal target can be treated as deleted.
Milestone String True The period during which a Goal Target is active.
Record ID Decimal True The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Record Creation Source String True Source (PropertySource) that created this object record.
Record Creation Source ID String True The sourceId -- further detail -- of the source that created this object record.
Record Creation Source User ID Decimal True User ID of the user who initiated creation of this object record.
Outcome String True Goal Target outcome.
Owner ids of all owners String True The owner IDs of all owners of this object.
Participant type String True The type of participant for the Goal Target.
Pipeline ids String True List of deal pipelines that the quota applies to. Used to calculate kpi values.
Pipelines String True A serialized list of pipeline IDs used to filter the KPI value calculation.
Progress updates notification frequency String True The frequency of goal progress update notifications.
Read Only Object Bool True Is the object read only.
Notify on goal achieved String True Opt into notifications when goal is achieved.
Notify with goal edit updates String True Opt into goal edit update notifications.
Notify on goal exceeded String True Opt into notifications when goal is exceeded.
Notify on goal kickoff String True Opt into notifications when a goal is kicked off.
Notify on goal missed String True Opt into notifications when a goal is missed.
Notify with progress updates String True Opt into goal progress updates notifications.
ShouldRecalculate String True Property used to flag Goal targets that need to be recalculated.
Start datetime Datetime True The first day that goal target's date range covers.
Static KPI Filter Groups String True Goal Target Filter Group(s) for all filters except time-based filters.
Status String True The status of the Goal Target.
Status display order Decimal True The goal status display order.
Target amount Decimal True The target amount for this goal target.
Target amount in company currency Decimal True The amount of the goal target, using the exchange rate, in your company's currency.
Team ID Decimal True The team ID associated with the Goal Target.
Ticket pipelines String True A serialized list of TICKET pipeline IDs used to filter the KPI value calculation.
Unique creation key String True Unique property used for idempotent creates.
Updated by user ID Decimal True The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User ID Decimal True The user ID associated with the Goal Target.
User IDs of all notification followers String True The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers String True The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners String True The user IDs of all owners of this object.
Performed in an import Bool True Object is part of an import.
Owner Assigned Date Datetime True The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner String True The owner of the object.
HubSpot Team String True The primary team of the owner.
Start date Date True The first day that goal target's date range covers.
Kpi progress percent Decimal True Progress percent is represented by the kpi value as a percent of the target amount.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9032