HubSpot: Retrieve performance
HubSpot sequences.retrievePerformance: arguments, response, policy and SDK examples.
← Sequences operations · Get started
Operation hubspot.sequences_retrieve_performance
Provider route: GET /automation/sequences/2026-09/serviceaccounts/sequences/{sequenceId}/performance. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["sequences"]["retrievePerformance"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.sequences.retrievePerformance(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.sequences.retrieve_performance(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.sequenceId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.timelineInterval | string | Optional | Default: WEEK |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve performance — response body |
Referenced models: Retrieve performance — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Retrieve performance — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
companyMetrics | Model | Optional | Expand Retrieve performance — response body — company Metrics |
sequenceId | string | Required within parent | The unique identifier for the sequence, represented as a string. |
statusByStep | array | Required within parent | An array of objects detailing the enrollment status for each step in the sequence, including the count and current step order. |
statusByStep[] | Model | Each item | Expand Retrieve performance — response body — status By Step item |
steps | array | Required within parent | An array of objects, each representing the performance metrics for individual steps within the sequence. |
steps[] | Model | Each item | Expand Retrieve performance — response body — steps item |
summary | Model | Required within parent | Expand Retrieve performance — response body — summary |
timeline | array | Required within parent | An array of objects representing points in time with specific performance metrics, such as enrollments and meetings booked. |
timeline[] | Model | Each item | Expand Retrieve performance — response body — timeline item |
Referenced models: Retrieve performance — response body — company Metrics, Retrieve performance — response body — status By Step item, Retrieve performance — response body — summary, Retrieve performance — response body — steps item, Retrieve performance — response body — timeline item
Retrieve performance — response body — company Metrics
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
companiesEngaged | JSON | Required within parent | |
companiesEngaged (anyOf 1) | integer | Alternative | The number of companies that have engaged with the sequence. An integer in int64 format. Format: int64 |
companiesEngaged (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
companiesEnrolled | JSON | Required within parent | |
companiesEnrolled (anyOf 1) | integer | Alternative | The number of companies that have been enrolled in the sequence. An integer in int64 format. Format: int64 |
companiesEnrolled (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
companiesScheduledMeeting | JSON | Required within parent | |
companiesScheduledMeeting (anyOf 1) | integer | Alternative | The number of companies that have scheduled a meeting as a result of the sequence. An integer in int64 format. Format: int64 |
companiesScheduledMeeting (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
contactsEnrolledWithCompanyId | JSON | Required within parent | |
contactsEnrolledWithCompanyId (anyOf 1) | integer | Alternative | The number of contacts enrolled in the sequence that are associated with a company ID. An integer in int64 format. Format: int64 |
contactsEnrolledWithCompanyId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve performance — response body — status By Step item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | An integer in int64 format representing the number of enrollments at the current step. Format: int64 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currentStepOrder | JSON | Required within parent | |
currentStepOrder (anyOf 1) | integer | Alternative | An integer indicating the order of the current step in the sequence. Format: int32 |
currentStepOrder (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
enrollmentStatus | string | Required within parent | A string representing the status of the enrollment at the current step. |
Retrieve performance — response body — summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
associatedDeals | JSON | Optional | |
associatedDeals (anyOf 1) | integer | Alternative | The number of deals associated with the sequence. Represented as an integer in int64 format. Format: int64 |
associatedDeals (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
bounced | JSON | Required within parent | |
bounced (anyOf 1) | integer | Alternative | The number of emails in the sequence that bounced. Represented as an integer in int64 format. Format: int64 |
bounced (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
clicked | JSON | Required within parent | |
clicked (anyOf 1) | integer | Alternative | The number of times links in the sequence emails have been clicked. Represented as an integer in int64 format. Format: int64 |
clicked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
contacts | JSON | Required within parent | |
contacts (anyOf 1) | integer | Alternative | The total number of contacts associated with the sequence. Represented as an integer in int64 format. Format: int64 |
contacts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dealsClosed | JSON | Optional | |
dealsClosed (anyOf 1) | integer | Alternative | The number of deals closed as a result of the sequence. Represented as an integer in int64 format. Format: int64 |
dealsClosed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
engaged | JSON | Required within parent | |
engaged (anyOf 1) | integer | Alternative | The number of contacts who engaged with the sequence. Represented as an integer in int64 format. Format: int64 |
engaged (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
enrolled | JSON | Required within parent | |
enrolled (anyOf 1) | integer | Alternative | The number of contacts enrolled in the sequence. Represented as an integer in int64 format. Format: int64 |
enrolled (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
meetingsBooked | JSON | Required within parent | |
meetingsBooked (anyOf 1) | integer | Alternative | The number of meetings booked as a result of the sequence. Represented as an integer in int64 format. Format: int64 |
meetingsBooked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
noResponse | JSON | Required within parent | |
noResponse (anyOf 1) | integer | Alternative | The number of contacts who did not respond to the sequence. Represented as an integer in int64 format. Format: int64 |
noResponse (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
opened | JSON | Required within parent | |
opened (anyOf 1) | integer | Alternative | The number of times emails in the sequence have been opened. Represented as an integer in int64 format. Format: int64 |
opened (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
replied | JSON | Required within parent | |
replied (anyOf 1) | integer | Alternative | The number of replies received from emails in the sequence. Represented as an integer in int64 format. Format: int64 |
replied (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalRevenue | JSON | Optional | |
totalRevenue (anyOf 1) | number | Alternative | The total revenue generated from the sequence. Represented as a number. |
totalRevenue (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unsubscribed | JSON | Required within parent | |
unsubscribed (anyOf 1) | integer | Alternative | The number of contacts who unsubscribed from the sequence. Represented as an integer in int64 format. Format: int64 |
unsubscribed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve performance — response body — timeline item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enrolledAt | JSON | Required within parent | |
enrolledAt (anyOf 1) | integer | Alternative | The time at which the enrollment occurred, represented as a Unix timestamp in milliseconds. Format: int64 |
enrolledAt (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
enrollments | JSON | Required within parent | |
enrollments (anyOf 1) | integer | Alternative | The total number of enrollments recorded at this point in the sequence timeline. Represented as an integer. Format: int64 |
enrollments (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
meetingsBooked | JSON | Required within parent | |
meetingsBooked (anyOf 1) | integer | Alternative | The number of meetings booked at this point in the sequence timeline. Represented as an integer. Format: int64 |
meetingsBooked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.sequences_retrieve_performance. Catalog operation: sequences_retrieve_performance. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["automation.sequences.read"]