Reports API Reference

This section describes the API endpoints for managing reports, including creating and managing report subscriptions, executing report deliveries, and managing usage report jobs.

1. Report Subscription Management

Feature：Report Subscriptions

• Create Report Subscription POST /api/v1/reports/subscriptions
• List Report Subscriptions GET /api/v1/reports/subscriptions

• Get Report Subscription Details GET /api/v1/reports/subscriptions/{subscriptionId}
• Update Report Subscription PUT /api/v1/reports/subscriptions/{subscriptionId}
• Delete Report Subscription DELETE /api/v1/reports/subscriptions/{subscriptionId}
• List Report Subscription Deliveries GET /api/v1/reports/subscriptions/{subscriptionId}/deliveries
• Update Report Subscription Status PATCH /api/v1/reports/subscriptions/{subscriptionId}/status
• Execute Report Subscription POST /api/v1/reports/subscriptions/{subscriptionId}:execute

2. Usage Report Job Management

Feature：Usage Report Jobs

• Create Usage Report Job POST /api/v1/reports/usage-jobs
• List Usage Report Jobs GET /api/v1/reports/usage-jobs
• Get Usage Report Job Details GET /api/v1/reports/usage-jobs/{usageJobId}
• Update Usage Report Job PUT /api/v1/reports/usage-jobs/{usageJobId}
• Delete Usage Report Job DELETE /api/v1/reports/usage-jobs/{usageJobId}
• List Usage Report Job Summaries GET /api/v1/reports/usage-jobs/{usageJobId}/summaries

---

Last updated on Mar-31, 2026 | Version 1.0.0