Reporter
Fetch & Download Reports
Check report status and download when ready
After requesting a report, you need to poll for its status and download it once available.
Check report status
GET https://api.volt.io/reports/{reportId} \
Authorization: Bearer YOUR_ACCESS_TOKENResponse
{
"id": "report-uuid-here",
"type": "PAYMENTS",
"status": "REPORT_AVAILABLE",
"createdAt": "2024-01-15T10:30:00Z",
"generatedAt": "2024-01-15T10:31:45Z"
}Report statuses
| Status | Description | Action |
|---|---|---|
REPORT_REQUESTED | Request received | Wait and poll again |
REPORT_GENERATING | Being generated | Wait and poll again |
REPORT_AVAILABLE | Ready for download | Download the report |
REPORT_FAILED | Generation failed | Check error, retry if needed |
REPORT_REMOVAL_REQUESTED | Deletion requested | Wait for removal |
REPORT_REMOVED | Report deleted | Request a new report |
Polling recommendation: Poll every 1-2 seconds until status changes to REPORT_AVAILABLE or REPORT_FAILED.
List all reports
Get a list of all your reports:
GET https://api.volt.io/reports \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"Optional parameters
| Parameter | Description |
|---|---|
customerId | Filter reports by customer |
Response
{
"reports": [
{
"id": "report-uuid-1",
"type": "PAYMENTS",
"status": "REPORT_AVAILABLE",
"createdAt": "2024-01-15T10:30:00Z",
"generatedAt": "2024-01-15T10:31:45Z"
},
{
"id": "report-uuid-2",
"type": "CONNECT",
"status": "REPORT_GENERATING",
"createdAt": "2024-01-15T11:00:00Z"
}
]
}Download a report
Once status is REPORT_AVAILABLE, download the CSV:
GET https://api.volt.io/reports/{reportId}/download \
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/csvHow is this guide?
Last updated on