Reports & Dashboards API

Access your reports and dashboards programmatically. Generate AI reports, retrieve dashboard data, and download report files.

Reports

List Reports

GET /api/v1/reports
Authorization: Bearer claribi_key_abc123...

Returns all reports in your organization.

Get Report Detail

GET /api/v1/reports/{id}
Authorization: Bearer claribi_key_abc123...

Returns the full report including executive summary, key findings, and recommendations.

Generate a Report

POST /api/v1/reports/{id}/generate
Authorization: Bearer claribi_key_abc123...

Triggers AI-powered report generation. Report generation runs in the background.

Download a Report

GET /api/v1/reports/{id}/download/
Authorization: Bearer claribi_key_abc123...

Downloads the report file in the format specified during generation.

Delete a Report

DELETE /api/v1/reports/{id}/
Authorization: Bearer claribi_key_abc123...

Permanently deletes a report. Requires reports:delete scope.

Generate/Revoke Public Link (Report)

POST /api/v1/reports/{id}/public-link/
Authorization: Bearer claribi_key_abc123...

Generates a public shareable URL. Returns public_url and access_token. Requires reports:share scope.

DELETE /api/v1/reports/{id}/public-link/
Authorization: Bearer claribi_key_abc123...

Revokes the public link immediately.

Dashboards

List Dashboards

GET /api/v1/dashboards/
Authorization: Bearer claribi_key_abc123...

Returns all dashboards in your organization. Supports ?status=, ?name=, ?created_after=, ?created_before=, ?ordering= query params.

Create a Dashboard

POST /api/v1/dashboards/
Authorization: Bearer claribi_key_abc123...
Content-Type: application/json

{"name": "Revenue Overview", "data_source_ids": ["uuid1", "uuid2"]}

Creates a new dashboard linked to the specified data sources. Requires dashboards:create scope.

Get Dashboard Detail

GET /api/v1/dashboards/{id}/
Authorization: Bearer claribi_key_abc123...

Returns dashboard metadata and all widget configurations.

Update a Dashboard

PATCH /api/v1/dashboards/{id}/
Authorization: Bearer claribi_key_abc123...
Content-Type: application/json

{"name": "Updated Name"}

Updates dashboard metadata. Requires dashboards:update scope.

Delete a Dashboard

DELETE /api/v1/dashboards/{id}/
Authorization: Bearer claribi_key_abc123...

Permanently deletes a dashboard. Requires dashboards:delete scope.

Refresh Dashboard

POST /api/v1/dashboards/{id}/refresh/
Authorization: Bearer claribi_key_abc123...

Triggers AI re-analysis (synchronous). Requires dashboards:refresh scope.

Response includes credits_consumed, ai_credits_used, ai_credits_limit, and ai_credits_remaining.

Generate/Revoke Public Link (Dashboard)

POST /api/v1/dashboards/{id}/public-link/
Authorization: Bearer claribi_key_abc123...

Generates a public shareable URL. Requires dashboards:share scope.

DELETE /api/v1/dashboards/{id}/public-link/
Authorization: Bearer claribi_key_abc123...

Revokes the public link immediately.

Goals

Read-only access to goals, milestones, and AI insights. Requires goals:read scope.

List Goals

GET /api/v1/goals/
Authorization: Bearer claribi_key_abc123...

Returns all goals. Supports ?hierarchy_type=epic|topic|task and ?status= filters.

Get Goal Detail

GET /api/v1/goals/{id}/
Authorization: Bearer claribi_key_abc123...

Returns goal details including milestones, data source count, and recent AI insights.

Get Goal Progress

GET /api/v1/goals/{id}/progress/
Authorization: Bearer claribi_key_abc123...

Returns progress snapshot: current_value, target_value, progress_percentage, milestones.

Related

• API Overview
• Authentication
• Reports Documentation