Welcome to the IntelliFront BI API
Choose the right integration path for native reports, dashboards, KPIs and reporting workflows.
Use the IntelliFront BI API to connect your application to the analytics and reporting resources in your own IFBI installation. A good first integration is small: authenticate, find an existing resource, and complete one useful task before automating a larger process.
Start with the reporting experience you need
IFBI creates its own reports, dashboards and KPIs over business data. Datasets provide reusable data configuration, dashboards hold visual reporting, and canvases bring dashboards and KPIs together for an audience. Power BI, SSRS and Crystal Reports are separate integrations for bringing existing reporting into that environment.
The API supports resource administration and native KPI calculations. Interactive dashboard viewing uses the IFBI viewing and sharing experience. Keeping those roles clear will help you choose the right implementation.
| Your goal | Start here |
|---|---|
| Make your first authenticated request | Connect to your installation |
| Prepare reusable business data | Datasets and connections |
| Use a native KPI in another application | Native KPI calculations |
| Give a customer a prepared reporting workspace | Customer analytics setup |
| Show a dashboard inside an application | Sharing and embedding |
| Trigger an existing report job | On-demand report jobs |
How to use this portal
Guides explain the decisions, resource relationships and operational details. Recipes provide complete Python examples with walkthroughs. The API reference gives the exact methods, paths, request models and response shapes for individual operations.
IFBI installs its web application and API in IIS. The web application normally uses HTTPS on port 443, while the API normally uses port 50255. Send requests to your API URL, including its configured port and application path, rather than the web application URL. The example.com host in the reference is a placeholder. Your account permissions, configured connections, installed build and licensing determine what a request can do.
A sensible first milestone
Follow authentication, list an existing native dashboard, and retrieve one KPI result. Then verify the outcome with the intended user account. That gives you a working connection and a concrete reporting use case before you add provisioning, sharing or scheduled work.
Continue with Connect to your IntelliFront installation.
Updated about 8 hours ago