Reports & Dashboards API
Estimated reading time: 15 minutes
Access your reports and dashboards programmatically. Generate AI reports, retrieve dashboard data, and download report files.
Reports
List Reports
GET /api/v1/reports
X-API-Key: claribi_key_abc123...Returns all reports in your organization.
Get Report Detail
GET /api/v1/reports/{id}
X-API-Key: claribi_key_abc123...Returns the full report including executive summary, key findings, and recommendations.
Generate a Report
POST /api/v1/reports/{id}/generate
X-API-Key: claribi_key_abc123...Triggers AI-powered report generation. Report generation runs in the background.
Download a Report
GET /api/v1/reports/{id}/download
X-API-Key: claribi_key_abc123...Downloads the report file.
Dashboards
List Dashboards
GET /api/v1/dashboards
X-API-Key: claribi_key_abc123...Returns all dashboards in your organization.
Get Dashboard Detail
GET /api/v1/dashboards/{id}
X-API-Key: claribi_key_abc123...Returns dashboard metadata and all widget configurations.
Refresh Dashboard
POST /api/v1/dashboards/{id}/refresh
X-API-Key: claribi_key_abc123...Triggers a refresh of the dashboard data with AI analysis.
Response includes ai_credits_remaining, ai_credits_used, and ai_credits_limit.
Related
Ready to try clariBI?
Start your free 14-day trial. No credit card required.