Skip to content

docs: clarify global deduplication for sum_distinct and average_distinct #648

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.

Sign up for GitHub

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify global deduplication for sum_distinct and average_distinct #648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions references/metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,10 @@ The `sum_distinct` metric requires:

The metric orders by the value being summed and takes the first occurrence for each unique combination of distinct keys. If there are different values for the same distinct key combination, the first one encountered will be used.

<Note>
Deduplication always happens globally on the `distinct_keys` you define, regardless of which dimensions you select in a query. The resulting total is the same value across every output row — selecting an extra dimension does not break the total down per group. If you need per-group results, set `distinct_keys` to include the grouping field.
</Note>

**Example: Summing order shipping costs**

Consider a model containing `order_id`, `order_item_id`, and `order_shipping_cost`:
Expand Down Expand Up @@ -1073,6 +1077,10 @@ The `average_distinct` metric requires:

The metric orders by the value being averaged and takes the first occurrence for each unique combination of distinct keys. If there are different values for the same distinct key combination, the first one encountered will be used.

<Note>
Deduplication always happens globally on the `distinct_keys` you define, regardless of which dimensions you select in a query. The resulting average is the same value across every output row — selecting an extra dimension does not break the average down per group. If you need per-group results, set `distinct_keys` to include the grouping field.
</Note>

**Example: Averaging order shipping costs**

Consider a model containing `order_id`, `order_item_id`, and `order_shipping_cost`:
Expand Down
Loading