Skip to content

update audit logs api doc to include pagination for mt saas#2814

Open
jennwandb wants to merge 2 commits into
mainfrom
jennwandb/update-auditlogs-pag
Open

update audit logs api doc to include pagination for mt saas#2814
jennwandb wants to merge 2 commits into
mainfrom
jennwandb/update-auditlogs-pag

Conversation

@jennwandb

@jennwandb jennwandb commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Description

Updates audit logs API documentation now that
pagination within a date range has been implemented
for MT SaaS.

@jennwandb jennwandb requested a review from a team as a code owner June 26, 2026 00:09
@mintlify

mintlify Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Jun 26, 2026, 12:14 AM

@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (1 total)

📄 Pages (1)

File Preview
platform/hosting/monitoring-usage/audit-logging.mdx Audit Logging

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: f49cb25 at 2026-07-08 22:30:49 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-jennwandb-update-auditlogs-pag.mintlify.app

@jennwandb jennwandb requested a review from mdlinville June 26, 2026 00:17

@mdlinville mdlinville 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.

Apologies for missing this review request for two weeks! I had a couple questions that might point more to my confusion than anything else. HMU for a quick re-review.

- `startDate`: Optional. Use `startDate=YYYY-MM-DD` to set the oldest calendar day in the range. Dates are interpreted in UTC.
- Supported in **Multi-tenant Cloud** only with an Enterprise license.
- Supported in **Dedicated Cloud** and **Self-Managed** v0.80.0 and above.
- `numDays`: An integer that indicates how many days after `startDate` to fetch logs. If you omit it or set it to `0`, logs are fetched for the `startDate` only. For example, `startDate=2026-01-01&numDays=2` fetches logs for January 1, January 2, and January 3, 2026. On **Multi-tenant Cloud**, `numDays` must be an integer from `0` through `7`.

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.

This seems somewhat redundant with the details around lines 89-92, but maybe that's just me being confused.

- `count`: The number of audit log entries returned in this response.
- `next_cursor`: An opaque cursor for the next page of results. If this field is `null`, there are no more results for the selected date range.

To paginate on **Multi-tenant Cloud**, repeat the request with the same date range, and set `cursor` to the `next_cursor` value from the previous response. Continue until `next_cursor` is `null`.

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.

This seems redundant with the details around lines 97-99?

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