Payouts

Export paid payout breakdown as CSV

Builds a CSV of the stored payout breakdown (totals, invoiced line items, per-rule contributions, and per-video shares where recorded) and returns a presigned download URL that expires after about 5 minutes.

post/payouts/{id}/breakdown/export

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/payouts/{id}/breakdown/export
  • Auth: API key in header x-api-key

Path parameters

idstring required

Payout ID with orgpay_ prefix

Example:orgpay_RwmraAffhMt9

Response

OK

downloadUrlstring uri required

Presigned download URL for the CSV export file

expiresAtstring date-time required

Expiration timestamp for the download URL (typically 5 minutes)

rowCountnumber required

Total number of data rows included in the export file

fileNamestring required

Generated filename for the export (includes timestamp)

Example response

{
  "downloadUrl": "https://storage.cloudflare.com/exports/video-daily-gains-2025-12-20-143052.csv?signature=abc123",
  "expiresAt": "2025-12-20T14:35:52.000Z",
  "rowCount": 15420,
  "fileName": "video-daily-gains-2025-12-20-143052.csv"
}

Changes

No recorded changes to this operation across all 1 revision of this API.