Skip to main content
POST
Generate download (deprecated)
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /download/generate/download ⚠️ DEPRECATED — Use POST /download/generate instead. This endpoint will be removed after 2026-06-01. Responses include Deprecation, Sunset, and Link headers pointing to the successor endpoint. Authorization:
  • Required role: user or higher
Method: POST

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

downloadEmail
string
required

Comma-separated email addresses

downloadFormat
string
required

Output format

downloadInclude
string

Data to include (raw, aggregates, aggregator)

type
string
default:royalty

Report type

Response

Download job created

status
string
Example:

"success"

message
string
data
object