> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve performance
> Retrieve the performance metrics of a specific sequence in your HubSpot account. This endpoint provides detailed insights into the sequence's effectiveness, including metrics such as opened, clicked, and replied rates. It is useful for analyzing the success of your sequences over time. Please note: the scopes for this endpoint requires user-level access and will not work for existing apps with portal-level access.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-09-beta/automation-sequences-v2026-09-beta.json GET /automation/sequences/2026-09-beta/serviceaccounts/sequences/{sequenceId}/performance
openapi: 3.0.1
info:
title: Automation Sequences
description: Basepom for all HubSpot Projects
version: 2026-09-beta
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
- name: Enrollment
paths:
/automation/sequences/2026-09-beta/serviceaccounts/sequences/{sequenceId}/performance:
get:
tags:
- Basic
summary: Retrieve performance
description: >-
Retrieve the performance metrics of a specific sequence in your HubSpot
account. This endpoint provides detailed insights into the sequence's
effectiveness, including metrics such as opened, clicked, and replied
rates. It is useful for analyzing the success of your sequences over
time. Please note: the scopes for this endpoint requires user-level
access and will not work for existing apps with portal-level access.
operationId: >-
get-/automation/sequences/2026-09-beta/serviceaccounts/sequences/{sequenceId}/performance
parameters:
- name: sequenceId
in: path
description: >-
The unique identifier of the sequence to retrieve performance
metrics for.
required: true
style: simple
explode: false
schema:
type: string
- name: timelineInterval
in: query
description: The interval for the timeline data. Defaults to 'WEEK'.
required: false
style: form
explode: true
schema:
type: string
default: WEEK
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSequencePerformanceResponse'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- automation.sequences.read
components:
schemas:
PublicSequencePerformanceResponse:
required:
- sequenceId
- statusByStep
- steps
- summary
- timeline
type: object
properties:
companyMetrics:
$ref: '#/components/schemas/PublicSequenceCompanyMetricsResponse'
sequenceId:
type: string
description: The unique identifier for the sequence, represented as a string.
statusByStep:
type: array
description: >-
An array of objects detailing the enrollment status for each step in
the sequence, including the count and current step order.
items:
$ref: '#/components/schemas/PublicSequenceEnrollmentStatusByStepResponse'
steps:
type: array
description: >-
An array of objects, each representing the performance metrics for
individual steps within the sequence.
items:
$ref: '#/components/schemas/PublicSequenceStepPerformanceResponse'
summary:
$ref: '#/components/schemas/PublicSequencePerformanceSummaryResponse'
timeline:
type: array
description: >-
An array of objects representing points in time with specific
performance metrics, such as enrollments and meetings booked.
items:
$ref: '#/components/schemas/PublicSequenceTimelinePointResponse'
PublicSequenceCompanyMetricsResponse:
required:
- companiesEngaged
- companiesEnrolled
- companiesScheduledMeeting
- contactsEnrolledWithCompanyId
type: object
properties:
companiesEngaged:
type: integer
description: >-
The number of companies that have engaged with the sequence. An
integer in int64 format.
format: int64
companiesEnrolled:
type: integer
description: >-
The number of companies that have been enrolled in the sequence. An
integer in int64 format.
format: int64
companiesScheduledMeeting:
type: integer
description: >-
The number of companies that have scheduled a meeting as a result of
the sequence. An integer in int64 format.
format: int64
contactsEnrolledWithCompanyId:
type: integer
description: >-
The number of contacts enrolled in the sequence that are associated
with a company ID. An integer in int64 format.
format: int64
PublicSequenceEnrollmentStatusByStepResponse:
required:
- count
- currentStepOrder
- enrollmentStatus
type: object
properties:
count:
type: integer
description: >-
An integer in int64 format representing the number of enrollments at
the current step.
format: int64
currentStepOrder:
type: integer
description: An integer indicating the order of the current step in the sequence.
format: int32
enrollmentStatus:
type: string
description: >-
A string representing the status of the enrollment at the current
step.
PublicSequenceStepPerformanceResponse:
required:
- calls
- callsConnected
- clicked
- executionCount
- meetingsBooked
- onTimeTaskCompletionCount
- onTimeTaskCompletionSum
- opened
- personalizationRateCount
- replied
- stepKey
- stepOrder
- tasksCompleted
type: object
properties:
calls:
type: integer
description: >-
An integer (int64) representing the number of calls made in this
step.
format: int64
callsConnected:
type: integer
description: >-
An integer (int64) indicating the number of calls that were
successfully connected in this step.
format: int64
clicked:
type: integer
description: >-
An integer (int64) showing the number of times links in emails from
this step have been clicked.
format: int64
executionCount:
type: integer
description: >-
An integer (int64) indicating the number of times this step has been
executed.
format: int64
meetingsBooked:
type: integer
description: >-
An integer (int64) representing the number of meetings booked as a
result of this step.
format: int64
onTimeTaskCompletionCount:
type: integer
description: >-
An integer (int64) representing the number of tasks completed on
time in this step.
format: int64
onTimeTaskCompletionSum:
type: integer
description: >-
An integer (int64) indicating the sum of on-time task completions
for this step.
format: int64
opened:
type: integer
description: >-
An integer (int64) indicating how many times emails from this step
have been opened.
format: int64
personalizationRateAvg:
type: number
description: >-
A number representing the average personalization rate for this
step.
personalizationRateCount:
type: integer
description: >-
An integer (int64) indicating the count of personalized actions in
this step.
format: int64
replied:
type: integer
description: >-
An integer (int64) representing the number of replies received from
emails sent in this step.
format: int64
stepKey:
type: string
description: A string that uniquely identifies the step.
stepOrder:
type: integer
description: An integer representing the order of the step within the sequence.
format: int32
tasksCompleted:
type: integer
description: >-
An integer (int64) indicating the number of tasks completed in this
step.
format: int64
PublicSequencePerformanceSummaryResponse:
required:
- bounced
- clicked
- contacts
- engaged
- enrolled
- meetingsBooked
- noResponse
- opened
- replied
- unsubscribed
type: object
properties:
associatedDeals:
type: integer
description: >-
The number of deals associated with the sequence. Represented as an
integer in int64 format.
format: int64
bounced:
type: integer
description: >-
The number of emails in the sequence that bounced. Represented as an
integer in int64 format.
format: int64
clicked:
type: integer
description: >-
The number of times links in the sequence emails have been clicked.
Represented as an integer in int64 format.
format: int64
contacts:
type: integer
description: >-
The total number of contacts associated with the sequence.
Represented as an integer in int64 format.
format: int64
dealsClosed:
type: integer
description: >-
The number of deals closed as a result of the sequence. Represented
as an integer in int64 format.
format: int64
engaged:
type: integer
description: >-
The number of contacts who engaged with the sequence. Represented as
an integer in int64 format.
format: int64
enrolled:
type: integer
description: >-
The number of contacts enrolled in the sequence. Represented as an
integer in int64 format.
format: int64
meetingsBooked:
type: integer
description: >-
The number of meetings booked as a result of the sequence.
Represented as an integer in int64 format.
format: int64
noResponse:
type: integer
description: >-
The number of contacts who did not respond to the sequence.
Represented as an integer in int64 format.
format: int64
opened:
type: integer
description: >-
The number of times emails in the sequence have been opened.
Represented as an integer in int64 format.
format: int64
replied:
type: integer
description: >-
The number of replies received from emails in the sequence.
Represented as an integer in int64 format.
format: int64
totalRevenue:
type: number
description: >-
The total revenue generated from the sequence. Represented as a
number.
unsubscribed:
type: integer
description: >-
The number of contacts who unsubscribed from the sequence.
Represented as an integer in int64 format.
format: int64
PublicSequenceTimelinePointResponse:
required:
- enrolledAt
- enrollments
- meetingsBooked
type: object
properties:
enrolledAt:
type: integer
description: >-
The time at which the enrollment occurred, represented as a Unix
timestamp in milliseconds.
format: int64
enrollments:
type: integer
description: >-
The total number of enrollments recorded at this point in the
sequence timeline. Represented as an integer.
format: int64
meetingsBooked:
type: integer
description: >-
The number of meetings booked at this point in the sequence
timeline. Represented as an integer.
format: int64
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: >-
The error category, indicating the general type of error that
occurred.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, represented as an object with
additional properties that are arrays of strings.
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets. It is formatted as a UUID.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: >-
Further information about the error, represented as an array of
ErrorDetail objects.
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate.
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: >-
The status code associated with the error detail, indicating the
type of error encountered.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, provided as an object with
additional properties. This can include specific details such as
missing scopes.
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: >-
The name of the field or parameter in which the error was found.
This provides context about where the error occurred.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. This is a required field.
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error, helping to further classify the error.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
automation.sequences.enrollments.write: ''
automation.sequences.read: ''
automation.sequences.write: ''
sequences-public-delete: ''
````
{product.name} -
{product.level}
)}