Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add marketo__first_date documentation #38

Merged
merged 2 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following table provides a detailed list of all tables materialized within t
| [marketo__campaigns](https://fivetran.github.io/dbt_marketo/#!/model/model.marketo.marketo__campaigns) | Each record represents a Marketo campaign, enriched with metrics about email performance. |
| [marketo__email_sends](https://fivetran.github.io/dbt_marketo/#!/model/model.marketo.marketo__email_sends) | Each record represents the send of a Marketo email, enriched with metrics about email performance. |
| [marketo__email_templates](https://fivetran.github.io/dbt_marketo/#!/model/model.marketo.marketo__email_templates) | Each record represents a Marketo email template, enriched with metrics about email performance. |
| [marketo__lead_history](https://fivetran.github.io/dbt_marketo/#!/model/model.marketo.marketo__lead_history) | Each record represents the state of a lead on a specific day. The columns in this model are specified with the `lead_history_columns` variable. |
| [marketo__lead_history](https://fivetran.github.io/dbt_marketo/#!/model/model.marketo.marketo__lead_history) | Each record represents the state of a lead on a specific day. The columns in this model are specified with the `lead_history_columns` variable. The start date is configured by the `marketo__first_date` variable, which by default, for dbt Core™ users, is the date of the earliest lead record, and for Fivetran Quickstart Data Model users, is 18 months in the past. There is currently no way to adjust this within the Quickstart environment, though incremental model runs will slowly look further and further in the past. However, please be aware that a full refresh will reset the clock and limit data to 18 months prior. |
| [marketo__leads](https://fivetran.github.io/dbt_marketo/#!/model/model.marketo.marketo__leads) | Each record represents a Marketo lead, enriched with metrics about email performance. |
| [marketo__programs](https://fivetran.github.io/dbt_marketo/#!/model/model.marketo.marketo__programs) | Each record represents a Marketo program, enriched with metrics about email performance. |

Expand Down Expand Up @@ -129,13 +129,16 @@ models:
#### Changing the Lead Date Range
Because of the typical volume of lead data, you may want to limit this package's models to work with a recent date range of your Marketo data (however, note that all final models are materialized as incremental tables).

By default, the package looks at all events since the earliest lead record, so do not include this variable unless you want to limit your data. To change this start date, add the following variable to your `dbt_project.yml` file:
By default, for dbt Core™ users, the package looks at all events since the earliest lead record, so do not include this variable unless you want to limit your `marketo__lead_history` data. To change this start date, add the following variable to your `dbt_project.yml` file:

```yml
models:
marketo:
marketo__first_date: "yyyy-mm-dd"
```

> For Fivetran Quickstart Data Model users, the package will look 18 months in the past. There is currently no way to adjust this within the Quickstart environment, though incremental runs will slowly look further and further in the past. However, please be aware that a full refresh will reset the clock and limit data to 18 months prior.

</details>

### (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™
Expand Down
2 changes: 1 addition & 1 deletion docs/catalog.json

Large diffs are not rendered by default.

47 changes: 10 additions & 37 deletions docs/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/manifest.json

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/run_results.json

This file was deleted.

12 changes: 10 additions & 2 deletions models/marketo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,12 @@ models:
description: '{{ doc("count_unique_clicks") }}'

- name: marketo__lead_history
description: Each record is what a Marketo lead looked like on each day.
description: >
Each record is what a Marketo lead looked like on each day. The columns in this model are specified with the `lead_history_columns` variable.

The start date is configured by the `marketo__first_date` variable, which by default, for dbt Core™ users, is the date of the earliest lead record.
For Fivetran Quickstart Data Model users, `marketo__first_date` is 18 months in the past. There is currently no way to adjust this within the Quickstart environment,
though incremental model runs will slowly look further and further in the past. However, please be aware that a full refresh will reset the clock and limit data to 18 months prior.
columns:
- name: lead_history_id
description: Surrogate key combining date_day and lead_id.
Expand All @@ -283,7 +288,10 @@ models:
- not_null

- name: date_day
description: The date of the lead was observed in this state.
description: >
The date of the lead was observed in this state. For dbt Core™ users, the default earliest `date_day` will be the date of the earliest lead record. This can be adjusted via the `marketo__first_date` variable.
For Fivetran Quickstart Data Model users, `marketo__first_date` is 18 months in the past. There is currently no way to adjust this within the Quickstart environment,
though incremental model runs will slowly look further and further in the past. However, please be aware that a full refresh will reset the clock and limit data to 18 months prior.

- name: marketo__leads
description: Each record is a Marketo lead.
Expand Down
Loading