docs: clarify Open Rate formulas for Prefetched Opens toggle#835
Draft
danielfsousa wants to merge 1 commit into
Draft
docs: clarify Open Rate formulas for Prefetched Opens toggle#835danielfsousa wants to merge 1 commit into
danielfsousa wants to merge 1 commit into
Conversation
Split the Enterprise "Open Rate" definition into two rows matching the "Include Prefetched Opens" / "Exclude Prefetched Opens" toggle in the Analytics Report UI, so the documented formula matches what the UI actually computes. Also adds the `count_nonprefetched_unique_confirmed_opened` API metric (referenced by the new formula) to the API metrics table.
✅ Deploy Preview for support-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
enterprise-metrics-definitions.mdinto two rows matching the UI's Prefetched Opens toggle, so the documented formula matches what the Analytics Report actually renders:Unique Confirmed Opens / AcceptedUnique Confirmed Non-prefetch Opens / (Accepted − Prefetched-only Openers), wherePrefetched-only Openers = Unique Confirmed Opens − Unique Confirmed Non-prefetch Openscount_nonprefetched_unique_confirmed_opened("Unique Confirmed Non-prefetch Opens") since it is referenced by the new formula and was not previously listed.lastUpdatedto today.Why
A customer (ICA Banken / Subaccount 10) reported that the displayed "Open Rate" for "Exclude Prefetched Opens" didn't match the formula in our public docs. The doc previously stated
Non-prefetch Opens / Accepted(simple ratio), but the deployed UI (@sparkpost/report-builder@v0.5.4) computes the adjusted-denominator form. With the customer's numbers the two differ meaningfully (~21.5% vs ~31.4%). Updating the doc to reflect actual production behavior so support answers stay grounded.Caveats
report-builderrepo has twofix:commits (33652a8,151d40a) on a0.7.xbeta tag that switch the metric back to the simpleNon-prefetch Opens / Acceptedformula. If/when those ship in a stable release and 2web2ui bumps its pin, the Exclude Prefetched Opens row here will need to be reverted to the simpler form. Worth coordinating with whoever owns that release.sp-metrics-definitions.md) intentionally left untouched — basic accounts don't exposecount_nonprefetched_unique_confirmed_openedso the existing single-formula row is internally consistent.Test plan
lastUpdatedis rendered as expected if any badge/widget uses it.