latestOpenAPI 3.0.32026-08-1931011.5 KB

4e64b163cbe4

Reports

Generate a report

Generate a report of clicks, transactions, or commissions for a given date range. Supports JSON and CSV output formats.

post/v1/report

Request body

start_datestring date required

Start date for the report period (YYYY-MM-DD).

end_datestring date required

End date for the report period (YYYY-MM-DD).

type'clicks' | 'transactions' | 'commissions' required

Report type.

format'json' | 'csv'

Response format. Defaults to "json".

Example request

{
  "start_date": "2026-01-01",
  "end_date": "2026-01-31",
  "type": "transactions",
  "format": "json"
}

Response

Report generated successfully. Returns JSON by default, or a CSV file when format is "csv".

report_idstring required

Unique report identifier.

type'clicks' | 'transactions' | 'commissions' required

Report type.

start_datestring date required

Report start date.

end_datestring date required

Report end date.

total_recordsinteger required

Number of records in the report.

Example response

{
  "report_id": "rpt_001abc",
  "total_records": 128,
  "data": [
    {
      "transaction_id": "txn_001abc",
      "amount": 49.99,
      "commission": 2.5,
      "status": "completed",
      "currency": "USD"
    }
  ]
}