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.
POST
/api/v1/core/reports/generateGenerate Statement Export
Trigger a streaming export report for any supported type. Reports are generated in the background; download URLs are returned immediately.
Request Headers
Header
Value
Authorization
Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type
application/json
X-Channel
api
Request Body
{
"report_type": "services",
"format": "xlsx",
"send_email": false,
"recipient_email": "finance@company.ng",
"start_date": "2026-08-01",
"end_date": "2026-08-26"
}Code Execution Playground
Request Snippet (CURL)
curl -X POST "https://backend.cbivas.com/api/v1/core/reports/generate" \
-H "Authorization: Bearer cbi_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"report_type":"services","format":"xlsx","start_date":"2026-08-01","end_date":"2026-08-26"}'Success Response (200 OK)
{
"task_id": "6321c91b-45a5-4fdc-9245-7323f6364cd7",
"artifact_id": "6321c91b-45a5-4fdc-9245-7323f6364cd7",
"detail": "Report generated"
}