Skip to content

docs: add Exporting Data page for Portkey and SCM - #1179

Merged
vrv-panw merged 2 commits into
mainfrom
docs/exporting-data
Nov 18, 2026
Merged

vrv-panw merged 2 commits into
mainfrom
docs/exporting-data

Conversation

@roh26it

@roh26it roh26it commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

Summary

New "Exporting Data" page, in product/observability/ (Portkey app) and aigw/product/observability/ (SCM), added to the Observability nav next to Logs Export. Three sections, each with an app flow and an API flow:

  1. Access audit logs: UI, filters, and GET /audit-logs with its required and optional query parameters and pagination.
  2. Export logs: Exports > Request Data in the app; POST /v1/logs/exports and /start in the API.
  3. Download exported logs: status and Download in the app; status, download URL, and file download in the API.

Links to Audit Logs and Logs Export for reference detail (fields, restrictions, full scripts). Roles, scopes, and permissions are intentionally not documented yet.

For reviewers

  • The SCM page is a first pass. Audit logs: Log Viewer > Common/Audit (not yet confirmed in SCM). The SCM audit logs API section says an endpoint isn't published in the AIRS API reference. SCM export and download steps mirror the existing aigw Logs Export page; the SCM navigation path to Exports and screenshots still need adding.
  • The existing Portkey Logs Export page says the feature is Enterprise only; the new page doesn't state availability, per the guidance that it is available to everyone. That page's note may need updating.
  • Verified against the Portkey OpenAPI spec for GET /audit-logs parameters. Prose-endpoint check passes for the new page (the two remaining failures are in cas.mdx, untouched).

🤖 Generated with Claude Code

Covers accessing audit logs (UI, API, filters), exporting logs (UI, API), and downloading exported logs (UI, API). Portkey page under product/observability, SCM page mirrored under aigw.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 18, 2026 14:20
@mintlify

mintlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
portkey-docs 🟢 Ready View Preview Nov 18, 2026, 2:44 PM

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

Copilot AI 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.

🟡 Changes recommended

Invalid cols=2 MDX syntax blocks page compilation, and export examples use unsupported field IDs in both documentation versions.

2 open issues
What changed in this PR

Adds “Exporting Data” guides to the Portkey and Strata Cloud Manager documentation, bringing audit-log access, request-log exports, and downloads into one task-oriented page.

Changes:

  • Documents app workflows and API examples for exporting and downloading logs.
  • Covers Portkey audit-log API filters and pagination, while noting the unpublished SCM endpoint.
  • Adds both pages to the Observability navigation beside Logs Export.
File Description
product/​observability/​exporting-data.mdx Adds the Portkey guide with app steps and API examples.
docs.json Registers both guides in Observability navigation.
aigw/​product/​observability/​exporting-data.mdx Adds the SCM guide with AIRS API examples and audit-log limitations.

Review effort: Balanced

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Copilot AI 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.

🔵 Needs a closer look

SCM audit-log navigation, export paths, and authentication flows remain unconfirmed and require validation by a product owner or reviewer with SCM access.

No open issues 🎉

2 resolved since last review

Review effort: Balanced

@vrv-panw
vrv-panw merged commit 680f191 into main Nov 18, 2026
4 checks passed

This branch was successfully deployed

1 active deployment
staging — 0b48b3b7 Deployed Nov 18, 2026 by mintlify[bot]
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.

3 participants