Reports

Generate a report

Changed on Oct 23, 2026

Sanity catalog only. Generate a report of transactions or commissions for a given date range. Supports JSON and CSV output formats.

The clicks report type is currently unavailable on this endpoint and returns a 400.

post/v1/report

Request

Base URL
https://api.cashbackhive.com
Auth
API key in header x-publisher-key

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. "clicks" is currently unavailable and returns a 400.

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": "pending",
      "currency": "USD"
    }
  ]
}

Changes

Oct 23, 202689457c5362eb Revision changes
- warning
  added the new approved enum value to the ////// response property for the response status (media type: application/json)
- warning
  added the new approved enum value to the ////// response property for the response status (media type: application/json)
- warning
  added the new cancelled enum value to the ////// response property for the response status (media type: application/json)
- warning
  added the new cancelled enum value to the ////// response property for the response status (media type: application/json)
- warning
  added the new pending enum value to the ////// response property for the response status (media type: application/json)
- warning
  added the new pending enum value to the ////// response property for the response status (media type: application/json)
- warning
  added the new unknown enum value to the ////// response property for the response status (media type: application/json)
- warning
  added the new unknown enum value to the ////// response property for the response status (media type: application/json)

Operation history