There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

Get performance statistics for a workflow

Last updated June 17, 2020

GET /automation/v3/performance/workflow/:workflowId

Note: The Workflows API currently only supports contact-based workflows.

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Required Scope:


Get a breakdown of the performance of a workflow based on the specified time period.

The response will include the number of contacts enrolled, the number of contacts unenrolled, and the number of contacts that completed the workflow for each period as specified in the bucket parameter.

Note: The response may not include an entry for each time period as there must be at least 1 contact in the specific bucket for it to be included. For example, in the example response to the right, no contacts were unenrolled on 2018-06-27 or 2018-06-28, so there is no entry for the "UNENROLLED" series for those dates.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header or hapikey={key} query parameter. Used to authenticate the request. Please see this page for more details about authentication.
Start date start=
Used in the request URL
The start date for the data you want. Must be specified as a millisecond timestamp.
End date end=
Used in the request URL
The end date for the data you want. Must be specified as a millisecond timestamp.
Time period bucket=
Used in the request URL
The time period used to group the data. Must be one of DAY, WEEK, or MONTH