Overview
The Reports API provides endpoints for generating various reports about API Proxies, API Proxy Groups, and access control. These reports are useful for auditing, compliance, and understanding API usage patterns.Endpoints
- API Report - Get report of all API Proxies and API Proxy Groups
- Organization API Data Model Access Report - Get organization-level API and data model access report
Authentication
All endpoints require authentication using a Personal API Access Token.Permissions
- User must have system admin (
sysAdmin) or system analyzer (sysAnalyzer) role - All report endpoints require system-level privileges
Permission Requirements
| Operation | Required Permission |
|---|---|
| API Report | System Admin (sysAdmin) or System Analyzer (sysAnalyzer) |
| Organization API Data Model Access Report | System Admin (sysAdmin) or System Analyzer (sysAnalyzer) |
Related Documentation
- Authentication Guide - How to obtain and use API tokens
- Error Handling - Error response formats