update audit logs api doc to include pagination for mt saas#2814
update audit logs api doc to include pagination for mt saas#2814jennwandb wants to merge 2 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
📚 Mintlify Preview Links📝 Changed (1 total)📄 Pages (1)
🤖 Generated automatically when Mintlify deployment succeeds |
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-jennwandb-update-auditlogs-pag.mintlify.app |
mdlinville
left a comment
There was a problem hiding this comment.
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`. |
There was a problem hiding this comment.
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`. |
There was a problem hiding this comment.
This seems redundant with the details around lines 97-99?
Description
Updates audit logs API documentation now that
pagination within a date range has been implemented
for MT SaaS.