docs: add the audit log page - #342
Merged
Merged
Conversation
Covers what the audit log records, retention by plan, who can read it, and how to page it over the REST API. Every action name, retention value, and query parameter is taken from the implementation rather than the design. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
jonoirwinrsa
marked this pull request as ready for review
September 7, 2026 20:11
The note told Hobby readers their activity is recorded where they cannot see it, which reads as surveillance rather than as a reason to upgrade. The retention table already says what each plan gets. Replace the passing mention of the filters with a short section framed around the questions people actually open the log to answer. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Saying which roles are refused invites the reader to reason about access they do not have. The line above already says who can read it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
wesrobin
approved these changes
Sep 11, 2026
How actors are persisted and resolved is ours, not the reader's. Keep the behaviour a rename does not break attribution and drop the mechanism. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The action table only needs to name the action. What each read hands back is not the reader's business. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Rename and deleted-account behaviour is edge-case trivia nobody reads the page for. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
No reason to document where the dashboard falls short. The actor parameter is already in the API table for anyone who needs it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Drop the rationale for why each action is recorded, the note restating the from clamp already in the table, and the pagination sentence that said nothing. Fold the one-sentence filtering section into viewing. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This branch was successfully deployed
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
2 participants
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.
Documents the audit log: what it records, retention by plan, who can read it, and how to page it over the REST API.
other-topics/audit-log.mdx, in the "Other concepts" group after request/response loggingDraft until the feature is generally available.