REST API Sources

If clariBI does not have a built-in connector for your data source, you can connect any REST API as a custom data source.

When to Use API Sources

Use the REST API connector when you have:

• An internal API that serves business data
• A third-party service without a built-in connector
• A custom data pipeline that exposes data via HTTP

Setup

Response Format

clariBI expects the API to return JSON. The best format is an array of objects:

{
  "data": [
    {"date": "2025-01-01", "product": "Widget A", "revenue": 1500},
    {"date": "2025-01-01", "product": "Widget B", "revenue": 2300},
    ...
  ]
}

Use the response mapping field to specify the path to the array (e.g., data in the example above).

Pagination

For APIs that return paginated results, clariBI can handle pagination during data sync to retrieve the complete dataset.

Sync Schedule

API sources sync based on your tier's cache duration. You can trigger manual syncs at any time. For frequently changing data, consider using shorter cache durations (available on higher tiers).

Limitations

• Only GET requests are supported (clariBI reads data, it does not write)
• Response must be JSON format
• Maximum response size depends on your tier's storage limits
• Rate limiting on the remote API may slow down initial syncs

Related

• Data Sources Overview
• Troubleshooting
• Data Sources API (for programmatic management)