Hubspot Metrics dbt Package (Docs)

🛑 Few things to keep in mind

These packages are under active development and are expected to change with dbt metrics as it evolves over time. As of now, dbt metrics requires users to define models to calculate metrics and these models are persisted on the warehouse. Keeping this in mind, we have currently modelled our packages such that metrics and the models calculating these metrics have a 1:1 mapping, which is why you will see multiple metrics for the same conceptual metric entity accounting for different time grains and dimensions. In future, with the roll out of dbt Server and evolution of dbt metrics, we expect to streamline our packages to remove these redundancies.

The metrics in these packages are transformed on top of source data ETL'd via Fivetran to your warehouse. Make sure you have connected your SaaS source with Fivetran for the packages to work properly.

📣 What does this dbt package do?

This package provides pre-built metrics for Hubspot data from Fivetran's connector. It uses data in the format described by this ERD.

This package enables you to access commonly used metrics on top of Hubspot campaigns.

Metrics

This package contains transformed models built on top of Fivetran Hubspot source package. A dependency on the source package is declared in this package's packages.yml file, so it will automatically download when you run dbt deps. The metrics offered by this package are described below

metric	description
hubspot__weekly_email_delivered_events	Weekly number of email delivered events.
hubspot__weekly_email_open_events	Weekly number of email open events.
hubspot__weekly_email_sent_events	Weekly number of email sent events.

🎯 How do I use the dbt package?

Step 1: Prerequisites

To use this dbt package, you must have the following:

• At least one Fivetran hubspot connector syncing data into your destination.
• A BigQuery, Snowflake, Redshift, or PostgreSQL destination.

Step 2: Install the package

Check dbt Hub for the latest installation instructions, or read the dbt docs for more information on installing packages.

Include in your packages.yml

packages:
  - git: "https://github.com/HousewareHQ/dbt_hubspot_metrics.git"
    revision: v0.1.0

Step 3: Define database and schema variables

By default, this package will look for your Hubspot data in the hubspot schema of your target database. If this is not where your Hubspot data is, please add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
config-version: 2

vars:
  hubspot_source:
    hubspot_database: your_database_name
    hubspot_schema: your_schema_name

For additional configurations for the source models, please visit the Hubspot source package.

(Optional) Step 4: Change build schema

By default this package will build the Hubspot staging models within a schema titled (<target_schema> + _stg_hubspot) and the Hubspot metrics within a schema titled (<target_schema> + _hubspot_metrics) in your target database. If this is not where you would like your modeled Hubspot data to be written to, add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
models:
  hubspot_metrics:
    +schema: my_new_schema_name # leave blank for just the target_schema
  hubspot_source:
    +schema: my_new_schema_name # leave blank for just the target_schema

🗄 Which warehouses are supported?

This package has been tested on Snowflake.

🙌 Can I contribute?

Additional contributions to this package are very welcome! Please create issues or open PRs against main. Check out this post on the best workflow for contributing to a package.

🏪 Are there any resources available?

• Provide feedback on what you'd like to see next
• Have questions, feedback, or need help? Email us at [email protected]
• Check out Houseware's blog
• Learn more about dbt in the dbt docs
• Check out Discourse for commonly asked questions and answers
• Join the chat on Slack for live discussions and support
• Find dbt events near you
• Check out the dbt blog for the latest news on dbt's development and best practices