Overview
clariBI provides a REST API that you can use to read data, export reports, and manage data sources programmatically. Third-party automation tools can call this API to build workflows that pull insights from clariBI into other systems.
Important: clariBI is not listed as a native app in any third-party automation marketplace (Zapier, Make, etc.). To integrate, you use the API directly via HTTP requests or through the "Webhooks by Zapier" / "HTTP" actions available in those tools.
What You Can Do With the API
The clariBI API supports read operations for pulling data out:
| Endpoint | Method | Description |
|---|---|---|
/api/data-sources/ |
GET | List connected data sources and their status |
/api/reports/ |
GET | List generated reports |
/api/dashboards/ |
GET | List dashboards |
/api/auth/status/ |
GET | Check authentication and organization status |
/api/billing/usage/ |
GET | Check current usage against plan limits |
For full endpoint documentation, see Endpoint Reference: Data Sources, Reports, Dashboards.
Authentication
All API requests require authentication via an API key or JWT token.
Using an API Key
- Go to Settings > Developer in clariBI.
- Click Create API Key.
- Give it a descriptive name (e.g., "Automation - Read Only").
- Copy the key. It starts with
claribi_sk_.
Include the key in request headers:
Authorization: Api-Key claribi_sk_your_key_here
See API Keys: Create, Scope, Rotate, Revoke for details.
Example: Pulling Data With Automation Tools
Using Zapier's "Webhooks by Zapier"
Since clariBI is not a native Zapier app, use the Webhooks by Zapier action:
- Create a Zap with your desired trigger (e.g., a schedule, a Slack command).
- Add a Webhooks by Zapier action and choose GET.
- Set the URL to
https://claribi.com/api/reports/(or another endpoint). - Add the header:
Authorization: Api-Key claribi_sk_your_key_here. - Test the step to verify you receive data.
- Add subsequent actions to process the response (e.g., send to Slack, write to Google Sheets).
Using cURL or Scripts
curl -H "Authorization: Api-Key claribi_sk_your_key_here" \
https://claribi.com/api/reports/
You can wrap this in a cron job, a GitHub Action, or any scheduling tool to automate periodic data pulls.
Getting Data Into clariBI
To get external data into clariBI, use one of the built-in data source types:
| Method | Best For |
|---|---|
| CSV / Excel upload | One-time or periodic manual imports |
| Database connection (PostgreSQL, MySQL) | Live data that changes frequently |
| REST API data source | Automated pulls from external APIs |
| Google Analytics / Sheets | Google ecosystem data via OAuth |
clariBI pulls data from sources on a schedule you configure. There is no inbound webhook endpoint for pushing data into clariBI -- instead, you connect clariBI to the source and it pulls data automatically.
See Connecting Your First Data Source for setup instructions.
Common Automation Patterns
Scheduled Report Export
Use a cron job or scheduled Zap to call the clariBI API daily and pull the latest report data into a Google Sheet or email.
Usage Monitoring
Call /api/billing/usage/ periodically to track AI credit consumption and data source counts. Send alerts via Slack or email when approaching plan limits.
Data Source Health Check
Call /api/data-sources/ to check the sync status of all connected sources. Flag any sources with errors or stale sync timestamps.
Best Practices
- Use a dedicated API key for each automation tool. If you need to revoke access for one tool, others are unaffected.
- Respect rate limits. Avoid calling the API more than necessary. Cache responses when possible.
- Use read-only keys when the automation only needs to pull data.
- Monitor API key usage in Settings > Developer to spot unexpected activity.