Articles in this section

Export data from HubSpot

Hubspot API: https://developers.hubspot.com/docs/methods/analytics/analytics-overview

Note

The Hubspot API does not currently support delta exports. When performing delta exports, create a filter to limit data to a specific time period.

HubSpot export form

360047079112-image-0.png
  1. Name: required: Give the export name.

  2. Description: Optional: Write a description of the export.

  3. Form view: Optional: Will default to HubSpot, but the user can switch to a generic adaptor form.

Choose the API and the operation

360047201991-image-1.png
  • API name: Required: HubSpot has many APIs. The customer needs to choose the name of the API that they want to connect to.

360047079132-image-2.png
  • Operations: Required: The customer will have to consult the API guide to know which operation that want to use.

360047079192-image-3.png
  • Configure search parameters: Optional: These search parameters are optional. They are all captured below.

Analytics API:

Link to the API: https://developers.hubspot.com/docs/methods/analytics/analytics-overview

Hubspot Analytics API for data breakdowns: https://developers.hubspot.com/docs/methods/analytics/get-analytics-data-breakdowns

These search parameters are the same for all “Operations” except ‘Check for existence of analytics data for an object type’ & ‘Get events.’ See the search params for those operations below.

Optional Search Parameters

360047079232-image-4.png
  1. Start: Use: start=YYYYMMDD. This will give a start date for the data you want to pull.

  2. End: Use: end-YYYYMMDD. This will give an end date for the data you want to access to.

  3. First drilldown: Use: d1= . Used to drill down into the data.The drilldown parameters are meant act similarly to the HubSpot sources report. Here some info from HubSpot’s Academy on the sources report . Note from HubSpot: Starter plans will not be able to use the drilldown parameters.

  4. Second Drilldown: Use: d2= . Used to drill down into the data. The drilldown params are meant to act similarly to the HubSpot source report. Here’s some info from HubSpot’s Academy on the sources report . Note from HubSpot: Starter plans will not be able to use the drilldown parameters.

  5. Filter: Use: f= . Filter the returned data to include only the specified breakdown. Note from Hubspot: At least one filter is required if time-periods = monthly, weekly, or daily.

  6. Exclude: Use: e= . Use this to exclude certain data for the specified breakdown. Can use this parameter multiple times to exclude multiple breakdowns.

  7. Analytics View ID: Use: filterId= . Returned data will only include data that matches the view. Note: User needs to perform a specific process in order to get the view ID, see below.

  8. Sort by: Use: sort= . Sorts by specified field.

  9. Sort direction: Use: sortDir= . Controls direction of results. Must be DESC or ASC.

To get Analytics View ID:

Follow the instructions on this page: https://developers.hubspot.com/docs/methods/analytics-views/get-views

Analytics View id sample:

360047202071-image-5.png

If Operation = ‘Check for existence of analytics data for an object type’

The user will be prompted to select from a list of object types.

360047079252-image-6.png

All of the ‘Object types’ are the options in this screenshot are options for this operation. The form DOES NOT change for any of these selections.

If ‘Operation” = ‘Get events’

360047202051-image-7.png

The search parameter is a boolean and the only option is true. If not configured, the default will be false.

CMS Blog API

The CMS Blog API is not a separate API. The “Operations” of the API are under the ‘CMS blog API’ section in the left panel. See screenshot below.

360047202091-image-8.png

The ‘List Blogs’ operation

Link to ‘List Blogs’: https://developers.hubspot.com/docs/methods/blogv2/get_blogs

360047079292-image-9.png
  1. API name: Required: Choose the API you want to connect to.

  2. Operation: Required: Choose the operation you want to connect to.

  3. Export type: Required: Choose between 4 ways to export:

  • All – always export all data

  • Delta – export only modified data

  • Once – export records only once

  • Limit – export a set number of records

  • Configure search parameters: Optional: The customer has the option to configure additional search params. See below for their descriptions.

CMS blog API: List Blog search parameters (1)

360047079272-image-10.png

Search params (2)

360047202111-image-11.png