CData Python Connector for HubSpot

Build 25.0.9454

Goals

Lists all goals configured in HubSpot, useful for performance tracking and goal management.

View Specific Information

In HubSpot, goals are used to create user-specific quotas for their sales and services teams.

SELECT

When selecting goals, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Goals;
SELECT * FROM Goals WHERE Id = '385180212151';

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Goals WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Goals WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Goals WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Goals WHERE ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value})

Columns

Name Type References Filterable Description
Id [KEY] Long True Unique identifier for the goal object.
Archived Bool False Indicates whether the goal is archived.
CreatedAt Datetime False The timestamp when the goal object was created.
UpdatedAt Datetime False The timestamp when the goal object was last updated.
MigrationSoftDeleteDeprecated String True Indicates whether the goal can be treated as deleted due to migration.
Ad account asset IDs String True Semicolon-separated list of ad account universally unique identifiers (UUIDs), formatted as {AD_NETWORK}-{ACCOUNT_ID}.
Ad campaign asset ids String True Semicolon-separated list of ad campaign UUIDs, formatted as {NETWORK}-{CAMPAIGN_ID}.
All teams String True IDs of all teams including those up the hierarchy, related to owner referencing properties.
Business units String True Business units that this goal record belongs to.
All owner ids String True List of all owner IDs for this object, both default and custom.
Team ids String True The team ID assigned to the goal; only one should be assigned.
Assignee team ID Decimal True Team ID assigned to the goal, if applicable.
Assignee user ID Decimal True User ID assigned to the goal, if applicable.
Campaign asset ids String True List of marketing campaign asset IDs associated with the goal.
Contact lifecycle stage String True The selected lifecycle stage for the goal, if the key performance indicator (KPI) involves contacts.
Created by user ID Decimal True The ID of the user who created the goal. Set automatically by HubSpot.
Object create date/time Datetime True Date and time when the goal object was created. Automatically assigned by HubSpot.
currency String True DEPRECATED. Currency code used for the goal target.
Currency Exchange Rate Decimal True Exchange rate for converting goal values into the company currency.
Deal pipelines String True Serialized list of deal pipeline IDs used in KPI filtering.
Edit updates notification frequency String True Frequency of notifications about edits to the goal.
End date Date True Last day that the goal's target date range covers (date format).
End datetime Datetime True Last day that the goal's target date range covers (datetime format).
Fiscal year offset Decimal True Offset in months for the fiscal year compared to the calendar year.
Goal name String True The name assigned to the goal.
Goal target currency code String True Currency code used for the goal's target amount.
Goal Target Group ID Decimal True The ID of the associated goal target group.
Goal type String True The type or category of the goal (such as revenue or engagement).
Group correlation UUID String True A unique identifier applied to all goal targets and groups created in a single request.
Is forecastable String True Indicates whether the goal is eligible to appear in forecasting applications.
IsLegacy String True Indicates whether the goal was migrated from a legacy system.
KPI Display Unit String True The display unit for KPI values if duration-based (such as hours or minutes).
KpiFilterGroups String True Serialized filter groups that define how KPI values should be calculated.
KPI is team rollup Bool True Indicates whether KPI values roll up from child teams in addition to the assigned team.
KpiMetricType String True Specifies the metric aggregation method such as sum, average, or count.
KpiObjectType String True The object type (such as deal or contact) on which the KPI calculation is based.
Kpi object type id String True The internal HubSpot ObjectTypeId for the KPI's base object type.
KpiPropertyName String True The name of the property used as the basis for KPI calculation.
KpiSingleObjectCustomGoalTypeName String True Custom goal definition for single-object KPIs (object, metric, property).
KpiTimePeriodProperty String True The date-type property used to filter KPIs by time period.
KpiTrackingMethod String True Defines how progress is tracked (either cumulative or point-in-time).
Kpi unit type String True The unit of measurement for the KPI (such as dollars, count, percent).
KPI value Decimal True The most recently calculated KPI value for the goal.
KPI value calculated at Decimal True The timestamp when the latest KPI value was calculated (epoch format).
KPI value last calculated at Datetime True Datetime of the most recent KPI value calculation.
Object last modified date/time Datetime True Timestamp of the most recent update to any goal property.
LegacyActive String True Indicates whether the goal is considered active in the legacy system.
LegacyCreatedAt Decimal True Timestamp representing when the legacy goal was originally created.
LegacyCreatedBy Decimal True User ID of the creator from the legacy system.
LegacyQuarterlyTargetCompositeId String True Concatenated IDs of the three monthly goals that formed a legacy quarterly goal.
LegacySqlId Decimal True The ID of the goal in the legacy SQL-based system.
LegacyUniqueSqlId Decimal True Unique ID of the goal from the legacy system to prevent duplication.
LegacyUpdatedAt Decimal True Timestamp of the last update to the goal in the legacy system.
LegacyUpdatedBy Decimal True User ID of the person who last updated the legacy goal.
Merged record IDs String True IDs of all records that were merged into this goal. Set by HubSpot automatically.
MigrationSoftDelete String True Indicates whether the goal should be soft-deleted due to migration processes.
Milestone String True The goal milestone period, such as monthly or quarterly.
Record ID Decimal True Unique record ID of the goal, set automatically by HubSpot.
Record Creation Source String True Source label indicating how the record was created (such as import or API).
Record Creation Source ID String True Detailed identifier of the creation source, such as integration ID.
Record Creation Source User ID Decimal True User ID of the person or system that initiated goal creation.
Outcome String True Final status or result of the goal, such as achieved or missed.
Owner ids of all owners String True All owner IDs associated with this goal record, including default and custom owners.
Participant type String True Specifies whether the goal is assigned to a user or a team.
Pipeline ids String True List of pipeline IDs to filter KPI calculations for deals.
Pipelines String True Serialized list of pipeline IDs used for KPI filtering.
Progress updates notification frequency String True Frequency setting for sending progress update notifications for this goal.
Read Only Object Bool True Indicates whether the goal record is read-only and cannot be edited.
Notify on goal achieved String True Indicates whether to notify users when a goal is achieved.
Notify with goal edit updates String True Indicates whether to notify users when goal settings are edited.
Notify on goal exceeded String True Indicates whether to notify users if the KPI exceeds the goal target.
Notify on goal kickoff String True Indicates whether to notify users when the goal period begins.
Notify on goal missed String True Indicates whether to notify users if the goal was missed.
Notify with progress updates String True Indicates whether to send regular progress updates to users.
ShouldRecalculate String True Flag indicating whether the goal's KPI values should be recalculated.
Start datetime Datetime True Start date and time of the goal's active period.
Static KPI Filter Groups String True Serialized filter groups for non-time-based filtering in KPI calculations.
Status String True The current status of the goal, such as Active or Completed.
Status display order Decimal True Determines the order in which statuses are displayed in the UI.
Target amount Decimal True The numeric value representing the target for this goal.
Target amount in company currency Decimal True Target amount converted to the company's primary currency using exchange rate.
Team ID Decimal True ID of the team assigned to the goal (used for team-based goal tracking).
Ticket pipelines String True Serialized list of ticket pipeline IDs used to filter KPIs when tracking support goals.
Unique creation key String True A unique string to ensure idempotent creation of goal records via API.
Updated by user ID Decimal True User ID of the person who last updated this goal.
User ID Decimal True ID of the user assigned to this goal (for user-based goals).
User IDs of all notification followers String True User IDs of those following this goal to receive notifications.
User IDs of all notification unfollowers String True User IDs of owners who opted out of receiving goal notifications.
User IDs of all owners String True User IDs of all current owners of this goal record.
Performed in an import Bool True Indicates whether the goal was created as part of a data import.
Owner Assigned Date Datetime True Timestamp of the most recent assignment of an owner to this goal.
Owner String True Primary owner of the goal, usually a user or team name.
HubSpot Team String True The primary team assigned to the goal's owner. Useful for team-based tracking and reporting.
Start date Date True The calendar date when the goal's target period begins.
Kpi progress percent Decimal True The progress toward the KPI target expressed as a percentage of the total goal.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454