Skip to content

Document audit log search and export#416

Merged
yummybomb merged 34 commits into
mainfrom
hypeship/document-audit-logs-api
Jul 22, 2026
Merged

Document audit log search and export#416
yummybomb merged 34 commits into
mainfrom
hypeship/document-audit-logs-api

Conversation

@yummybomb

@yummybomb yummybomb commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a task-oriented audit log guide for CLI, SDK, and HTTP search and export workflows
  • add a complete kernel audit-logs CLI command reference and navigation entry
  • document search pagination, export cursors, time-window semantics, filters, chunk limits, checksums, retries, and partial-file behavior
  • correct SDK exclude_method examples and replace the fabricated page token with an opaque response token

Rollout

Merge after a published CLI release contains kernel audit-logs download and published SDK releases include the complete download helpers:

The CLI behavior is unchanged.

Testing

  • mint broken-links
  • rendered /info/audit-logs and /reference/cli/audit-logs with the local Mintlify preview
  • go test ./cmd -run AuditLogs in the CLI repository
  • compiled the Go SDK download example against the helper branch
  • ran the TypeScript and Python download examples through their SDK test suites

Note

Low Risk
Docs and navigation only; no runtime, auth, or API behavior changes in this repo.

Overview
Adds audit log documentation for org-wide API request history: a new Guides page at /info/audit-logs and a CLI reference at /reference/cli/audit-logs, wired into docs.json and the CLI overview card grid.

The guide contrasts search (paginated JSON, SDK list / auto-paging) vs export (.jsonl.gz, SDK download with chunking, SHA-256 verification, and retries). It documents shared filters, [start, end) time windows (max 30 days), and TypeScript/Python/Go examples—including exclude_method on export.

The CLI reference covers kernel audit-logs search (default last 24h, GET excluded unless --include-get, --limit with internal paging) and kernel audit-logs download (required window, batch limits, checksums, .partial on move failure, no resume, --force), plus command aliases.

Reviewed by Cursor Bugbot for commit fb3c3ae. Bugbot is set up for automated code reviews on this repo. Configure here.

cursor[bot]
cursor Bot approved these changes Jun 23, 2026
@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Jun 23, 2026, 3:04 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Filters narrow results, not the time window; add --include to the HTTP
paging examples so the X-Next-Page-Token response header is visible.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

Evidence from the diff: the PR adds info/audit-logs.mdx and a single docs.json navigation entry. It doesn’t modify runtime code, prompt/model instruction files, auth or permissions logic, infrastructure, schemas, or shared production systems. The blast radius is limited to documentation rendering/navigation.

I found no CODEOWNERS file in the repo snapshot. The PR is already approved according to GitHub review state, so I’m not adding a duplicate approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

Evidence from the current diff: this PR adds info/audit-logs.mdx and one docs.json navigation entry. The latest update only adds/clarifies audit log documentation text, including the 30-day range note, filter wording, and curl --include examples. It doesn’t modify runtime code, prompt/model instruction files, auth or permissions logic, infrastructure, schemas, or shared production systems.

I found no CODEOWNERS file in the repo snapshot. The PR is already approved according to GitHub review state, so I’m not adding a duplicate approval. The post-approval update doesn’t increase risk, so no approval dismissal is needed.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@yummybomb yummybomb changed the title Document audit logs API Document audit log search and export Jul 16, 2026

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

Evidence from the current diff: this PR changes four documentation-site files only. It adds audit-log search/export guides and CLI reference content, plus two navigation/card entries in docs.json and reference/cli.mdx. It doesn't modify runtime code, model instruction files, authentication or permissions enforcement, infrastructure, schemas, or production services. The blast radius is limited to rendered documentation and navigation.

The latest post-approval update expands the documentation and examples but doesn't increase operational or security risk. No CODEOWNERS file is present in the repository, and GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

Evidence from the current diff: all changes are confined to four Mintlify documentation files. The latest update only reorganizes the audit-log guide, refines CLI/API wording and examples, and corrects reference links/table formatting. It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services. The blast radius remains limited to rendered documentation and navigation.

No CODEOWNERS file is present in the repository. GitHub already reports this PR as approved, so I haven't added a duplicate approval. The post-approval update doesn't increase risk, so the existing approval remains appropriate.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

Evidence from the current diff: all changes remain confined to four Mintlify documentation files—two new audit-log guides plus navigation/card entries. The newest update changes one sentence and removes a short prerequisite note in info/audit-logs.mdx; it doesn't add runtime behavior or affect authentication/permission enforcement, infrastructure, schemas, prompts, or production services. The blast radius is limited to rendered documentation.

No CODEOWNERS file is present in the repository. GitHub already reports the PR as approved, so I haven't added a duplicate approval. This post-approval update doesn't increase risk, so the existing approval remains appropriate.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The current diff is confined to four Mintlify documentation files: two audit-log documentation pages plus navigation/card entries. The latest update only expands the SDK examples to iterate through all export chunks and adds checksum/cursor guidance. It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius remains limited to rendered documentation.

No CODEOWNERS file is present at the PR head. GitHub already reports the PR as approved, so I haven't added a duplicate approval. The post-approval update doesn't increase risk, so the existing approval remains appropriate.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete diff remains confined to four Mintlify documentation files: two audit-log guides and two navigation/card updates. The latest post-approval update only reorganizes and trims info/audit-logs.mdx; it doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services. The blast radius is limited to rendered documentation.

No CODEOWNERS file is present in the repository, and GitHub already reports the PR as approved. I haven't added a duplicate approval, and because the update doesn't increase risk, the existing approval remains appropriate.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete diff remains confined to four Mintlify documentation files: two audit-log guides plus navigation/card entries. The newest update only removes duplicated raw HTTP examples, retitles two sections, and links to the API reference; it doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services. The blast radius remains limited to rendered documentation.

No CODEOWNERS file is present in the repository. GitHub already reports the PR as approved, so I haven't added a duplicate approval. This post-approval update doesn't increase risk, so the existing approval remains appropriate.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (289 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the prior assessment at 7010f3d, the latest update only documents jsonl.gz as the SDK download default and removes redundant explicit format arguments from the TypeScript, Python, and Go examples. This doesn't increase risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit fa09cc0. Configure here.

Comment thread info/audit-logs.mdx

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (289 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the prior assessment at fa09cc0, the latest update changes one documentation table cell to describe export output as gzip-compressed JSON Lines only (1 insertion, 1 deletion). This doesn't increase risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (285 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the prior assessment at 1497fae, the latest update only removes a four-line note about CLI-specific filtering behavior from info/audit-logs.mdx. This doesn't increase risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (285 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the previous assessment at 1a6991c, the latest update changes one warning sentence in info/audit-logs.mdx to keep partial-export guidance focused on SDK users (1 insertion, 1 deletion). This doesn't increase risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (281 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the previous assessment at 7f4637f, the latest update only removes a four-line warning about partial SDK export files from info/audit-logs.mdx. This doesn't increase operational or security risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (281 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the previous assessment at a793746, the latest update changes one sentence in info/audit-logs.mdx by removing the claim that event_id is a stable timestamp tie-breaker (1 insertion, 1 deletion). This doesn't increase risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (281 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the previous assessment at 485de11, the latest update changes one conjunction in a filter description in info/audit-logs.mdx (1 insertion, 1 deletion). This doesn't increase risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@sjmiller609 sjmiller609 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few small nits, otherwise lgtm

Comment thread info/audit-logs.mdx Outdated
Comment thread info/audit-logs.mdx Outdated
Comment thread info/audit-logs.mdx
Comment thread info/audit-logs.mdx
@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Error Error Jul 22, 2026 5:51pm

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

The complete merge-base diff changes only four Mintlify documentation files: two new audit-log pages plus navigation/card entries (281 additions, no deletions). It doesn't modify runtime code, model instruction files, authentication or permission enforcement, infrastructure, schemas, or production services, so the blast radius is limited to rendered documentation and navigation.

Since the latest approval at db51f69, the update changes five documentation lines in info/audit-logs.mdx to rename “workflow” to “endpoint” and add in-page links to the search and export sections. This doesn't increase risk. No CODEOWNERS file exists at the current head, and there are no pending review requests. GitHub already reports the PR as approved, so I haven't added a duplicate approval or dismissed the existing approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@yummybomb
yummybomb merged commit 11a4a27 into main Jul 22, 2026
6 of 7 checks passed
@yummybomb
yummybomb deleted the hypeship/document-audit-logs-api branch July 22, 2026 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants