docs: clarify scan_history page_size default and unsampled behavior#2743
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: clarify scan_history page_size default and unsampled behavior#2743mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (1 total)📄 Pages (1)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-mintlify-c1083870.mintlify.app |
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
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
Correct the documented
page_sizedefault forrun.scan_history()and clarify that it returns unsampled history.Changes
page_sizedefault from500to1000(matches the SDK reference forRun.scan_history).scan_historyreturns complete, unsampled history (vs. the sampledrun.history()).page_sizeandkeysare independent:keysfilters which metrics are returned,page_sizecontrols pagination.Context
Recent docs assistant traffic showed repeated questions about what
page_sizemeans inscan_history, whetherscan_historyreturns sampled data, and howkeysinteracts withpage_size. The page already covered the topic but had an incorrect default and didn't explicitly contrast the two history methods.