Repository navigation
docs: document storefront analytics - #10
Merged
Merged
Conversation
The API gained a public ingest endpoint and an admin shopper funnel (OpenTaberna/fastapi#47), and refreshing the snapshot made the drift check fail with two undocumented paths. Documents both, and the parts a reader cannot recover from the schema: that the pre-order steps are a floor rather than a count while the paid step is exact, why the ingest endpoint is public, what it refuses to store, and why none of it needs a consent banner. Also records why the endpoint returns 404 rather than 403 when collection is off, and adds STOREFRONT_ANALYTICS_ENABLED to the configuration reference. Closes #9 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YY1ekLLeFLkAU2kvdQ8Ey4
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.
Closes #9 · documents OpenTaberna/fastapi#47
Two endpoints landed and the drift check caught them:
What's documented
The endpoints, plus what a reader cannot recover from the schema:
That the funnel's steps are not equally trustworthy. Everything before
paiddepends onwhat browsers reported and is a floor;
paidcomes from the orders table and is exact. Afunnel that undercounts its first step but not its last overstates the drop, so the wiki
says real conversion is never worse than reported.
Why the ingest endpoint is public, what it refuses to store, and why none of it needs a
consent banner — that is the reason for the design, not a side effect.
Why it returns
404rather than403when off: a deployment that has not opted inshould not advertise a capability it is not offering.
Why
enabled: falseis reported explicitly — "nobody visited" and "we are not counting"otherwise look identical.
Verification
Snapshot regenerated from a live instance carrying the merged service (32 paths, up from 30).