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 and receive a requestId.
  2. Poll with both reportId and requestId every second until status is complete or failed.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The ID of the report

When true (default), column headers are included as the first row in the data array. When false, headers are only in the columnNames property.

Request ID for polling existing report generation status.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json