Skip to content
English
Log a Support Call Customer portal
  • There are no suggestions because the search field is empty.

Use the IntelliFront BI API with Datasets, Dashboards, KPIs and Canvases

Connect your application to native IntelliFront BI analytics using datasets, dashboard definitions, KPIs, canvases and content access.

IntelliFront BI creates native analytics from your business data. Its API helps applications work with the supported resources behind that reporting experience: data connections, datasets, dashboard definitions, KPIs, canvases and audience assignments.

For example, a service application can retrieve a configured workload KPI. An onboarding workflow can reuse approved reporting definitions and assemble a canvas for an existing customer group.

Prepare the data

A connection identifies the source; a dataset defines the query or file configuration used by reporting. Follow Work with datasets and data connections to read, save or reuse supported definitions. Dataset configuration calls are not a general API for extracting arbitrary table rows.

Reuse native dashboard designs

Create and test the visual design in IntelliFront BI, then use Manage native dashboard definitions to manage supported metadata and reuse definitions with compatible data bindings. Definition export retrieves the design for reuse; it does not return a rendered PDF or Excel report.

Retrieve KPI results

Use Work with native KPIs to read a saved measure, supply its calculation inputs and retrieve the result. Check the dataset, aggregation, units and rounding. When updating a goal, preserve the other required settings and read the KPI back.

Assemble the reader experience

A canvas brings dashboards and KPIs together. Follow Assemble canvases for your users to provide explicit content and audience assignments. Verify the underlying reporting permissions as well as the canvas assignment.

Check access and data freshness

Use users, groups and content access to review membership and reporting assignments. Test the experience using an intended reader account. Audience assignments and report parameters do not, by themselves, isolate one customer’s business data from another’s.

Use refresh history and data freshness to distinguish dataset processing, dashboard cache age and viewer refresh. A recent cache timestamp does not prove that upstream business data is current.

Try the workflow

Start with Get Started with the IntelliFront BI API. The recipes include KPI results, dataset reuse, canvas creation and access reviews. For repeatable customer setup, follow Plan repeatable customer analytics setup.