Analytics
Reports & Statement Exports
Trigger high-performance streaming generation of CSV and Excel (.XLSX) reports capable of processing millions of records with zero-OOM memory usage.
Architecture & Integration Guidelines:
- Supported types: transactions (wallet ledger), services (bill payments), sms (message history), ussd (session logs), reconciliation, settlement.
- Formats: csv or xlsx. Excel reports include styled headers and column grouping.
- Date Range: Pass start_date and end_date (YYYY-MM-DD) to scope the export. Omit to export all records.
GET
/api/v1/core/reports/{artifact_id}/downloadDownload Generated Report
Download a previously generated report file by its artifact ID. Returns binary file as streaming response.
Request Headers
Header
Value
Authorization
Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type
application/json
X-Channel
api
Query Parameters
Parameter
Type
Description
artifact_id*
string
The artifact ID returned from the generate endpoint
Code Execution Playground
Request Snippet (CURL)
curl -X GET "https://backend.cbivas.com/api/v1/core/reports/6321c91b.../download" \ -H "Authorization: Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx" \ --output "report.xlsx"
Success Response (200 OK)
{
"_note": "Returns binary file (CSV or XLSX) as streaming response with Content-Disposition: attachment header."
}