Hubspot Batch Source

Authorization method

No

1.1.0

Optional. Select either Hubspot account API Key or Private App Access Token option.

API Key (Deprecated)

Yes

Optional. Hubspot account API Key (Deprecated. See this guide for migrating to using a Private App Access Token.)

Private App Access Token

Yes

1.1.0

Optional. The app should be allowed to read the respective type (selected below) of Hubspot objects.

Reference Name

No

Required. Name used to uniquely identify this source for lineage, annotating metadata, etc.

Objects

Yes

Required. Type of the objects to pull from Hubspot.

Should be one of (follow the links for Hubspot documentation):

• Analytics

• Contact Lists

• Contacts

• Companies

• Deals

• Deal Pipelines

• Email events

• Email Subscription

• Marketing Email

• Products

• Recently Modified Companies

• Tickets

Time Period

Yes

Optional. Time period used to group the data. See reference documentation. Must be one of:

• total - Data is rolled up to totals covering the specified time.

• daily - Grouped by day.

• weekly - Grouped by week.

• monthly - Grouped by month.

• summarize/daily - Grouped by day, data is rolled up across all breakdowns.

• summarize/weekly - Grouped by week, data is rolled up across all breakdowns.

• summarize/monthly - Grouped by month, data is rolled up across all breakdowns.

Note: When using daily, weekly, or monthly for the Time Period, you must include at least one filter.

Report Type

Yes

Optional. Analytics report target to get data for. Must be one of (see below the details for each option):

• Content

• Category

• Object

Report Content

Yes

Optional. The type of content that you want to get data for (to get examples and more details see documentation) Must be one of:

• landing-pages - Pull data for landing pages.

• standard-pages - Pull data for website pages.

• blog-posts - Pull data for individual blog posts.

• listing-pages - Pull data for blog listing pages.

• knowledge-articles - Pull data for knowledge base articles.

Report Category

Yes

Optional. Analytics report category used to break down the analytics data (to get examples and more details see documentation). Must be one of:

• totals - Data will be the totals rolled up from.

• sessions - Data broken down by session details.

• sources - Data broken down by traffic source.

• geolocation - Data broken down by geographic location.

• utm-:utm_type - Data broken down by the standard UTM parameters. :utm_type must be one of campaigns, contents, mediums, sources, or terms (i.e. utm-campaigns).

Report Object

Yes

Optional. Analytics report type of object that you want the analytics data for (to get examples and more details see documentation). Must be one of:

• event-completions - Get data for analytics events. The results are broken down by the event ID. You can get the details for the events using this endpoint.

• forms - Get data for your HubSpot forms. The results are broken down by form guids. You can get the details for the forms through the Forms API.

• pages - Get data for all URLs with data collected by HubSpot tracking code. The results are broken down by URL.

• social-assists - Get data for messages published through the social publishing tools. The results are broken down by the broadcastGuid of the messages. You can get the details of those messages through the Social Media API.

Start Date

Yes

Optional. Start date for the report data. YYYYMMDD format.

End Date

Yes

Optional. End date for the report data. YYYYMMDD format.

Filters

Yes

Optional. Keywords to filter the analytics report data to include only the specified breakdowns.