Download a completed report export file

GET

/v1/organizations/{organizationId}/report-exports/{exportId}/download

• Test API

API key scope: reports:export. Generates the requested file on demand from the stored PostgreSQL snapshot.

Authorizations

• ApiKey

Parameters

Path Parameters

exportId

required

string

Header Parameters

X-Request-Id

string

Optional client request id returned in structured errors.

Responses

200

Report export file generated on demand.

string format: binary

string format: binary

403

The organization has exhausted its monthly public API request quota.

Media typeapplication/json

Example

{
  "error": {
    "code": "PLAN_LIMIT_EXCEEDED",
    "message": "Plan limit exceeded for api_requests",
    "requestId": "req_123",
    "details": {
      "entitlementKey": "api_requests",
      "scope": "environment",
      "environment": "live",
      "configured": true,
      "limit": "50000",
      "used": "50000",
      "requested": "1",
      "currentPlan": {
        "code": "free",
        "version": 1
      },
      "requiredPlan": {
        "code": "starter",
        "version": 1,
        "requiresOverride": false
      }
    }
  }
}