🚧 This project is currently in active development. A sandbox environment will be made available soon for testing and exploration. Stay tuned!
Report run history, or a single run by id (filters in the body)
Sandbox
Sandbox
POST
/v1/reports/history
{ "id": "<run id>" }. Returns that one runobject (checks completed runs first, then in-progress), or 404 if it
doesn't exist / isn't in your reseller scope.
{ limit?, reseller_id?, merchant_id? } (or an emptybody). Returns
{ runs: [...] }, newest first. When merchant_id issupplied the reseller's runs are filtered to that merchant; otherwise
all of the reseller's runs are returned.
id is present it takes precedence and the list filters are ignored.Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/reports/history' \
--header 'api_key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"id": "string",
"limit": 50,
"reseller_id": 0,
"merchant_id": 0
}'Response Response Example
200 - Example 1
{
"runs": [
{
"id": "rr_abc123",
"reseller_id": 0,
"merchant_id": 0,
"report_type": "string",
"request_type": "one_time",
"requested_by": "string",
"status": "pending",
"from_date": "2019-08-24",
"to_date": "2019-08-24",
"s3_path": "string",
"download_url": "string",
"row_count": 0,
"file_size_bytes": 0,
"completed_at": "string",
"error_code": "string",
"error_message": "string",
"created_at": "string",
"merchant_name": "string"
}
]
}