🚧 This project is currently in active development. A sandbox environment will be made available soon for testing and exploration. Stay tuned!
Trigger a one-time report generation
Sandbox
Sandbox
POST
/v1/reports/generate-report
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/reports/generate-report' \
--header 'api_key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"report_type": "transaction_activity",
"parameters": {
"from": "2019-08-24",
"to": "2019-08-24",
"merchant_id": 0
},
"reseller_id": 0
}'Response Response Example
201 - Example 1
{
"id": "string",
"reseller_id": 0,
"merchant_id": 0,
"report_type": "string",
"schedule_type": "one_time",
"cadence": "string",
"status": "active",
"run_status": "pending",
"from_date": "2019-08-24",
"to_date": "2019-08-24",
"email": "string",
"notification_email": "string",
"requested_by": "string",
"download_url": "string",
"row_count": 0,
"file_size_bytes": 0,
"error_code": "string",
"error_message": "string",
"completed_at": "string",
"expires_at": "string",
"next_run_at": "string",
"last_run_at": "string",
"last_run_status": "succeeded",
"created_at": "string",
"updated_at": "string",
"parameters": {
"property1": "string",
"property2": "string"
},
"merchant_name": "string"
}