report.generate

⚠️

Beta

This endpoint is currently in beta and may change without notice.

Generates a new report or polls the status of an existing report generation.

Two-step process:

1. Call with only reportId to start generation → returns requestId
2. Poll with both reportId and requestId every second until status is complete or failed

Example:

// Step 1: Start generation
POST /report.generate
{ "reportId": "abc-123-def-456" }
→ { "requestId": "rep_result:12345abc", "status": "in_progress", "reportData": null }

// Step 2: Poll for results
POST /report.generate
{ "reportId": "abc-123-def-456", "requestId": "rep_result:12345abc" }
→ { "requestId": "rep_result:12345abc", "status": "complete", "reportData": {...} }

Rate Limiting (Per Organization):

• Start generation requests (without requestId): 15 requests per minute per organization
• Concurrent limit: Maximum 3 report operations at once per organization (shared with report.synchronous)
• Polling requests (with requestId): Bypass all limits

Usage Notes:

• If you receive a 429 error, your organization has hit its limit - wait and retry or use report.synchronous
• For synchronous retrieval of existing data, use report.synchronous
• Use this async endpoint for reports that may exceed 30 seconds

Requires the reportsRead permission.