report.synchronous

Beta

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

Retrieves report data synchronously.

Timeout: 30 seconds. If a report is timing out, use the asynchronous report.generate instead.

Rate Limiting (Per Organization):

  • Request limit: 15 requests per minute per organization
  • Concurrent limit: Maximum 3 report operations at once per organization (shared with report.generate)
  • Rate limits are shared with report.generate for starting new generations

Usage Notes:

  • If you receive a 429 error, your organization has hit its limit - wait briefly and retry
  • For long-running reports, use report.generate for async processing
  • Concurrent limit is released when the HTTP request completes

Requires the reportsRead permission.

Body Params
uuid
required

The ID of the report

boolean
Defaults to true

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

Responses

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