Your first native analytics workflow in Postman

Start with an existing native KPI. This short workflow establishes a useful connection to IFBI without creating reporting resources or sending report output.

Before you begin

Import the collection and environment, set baseUrl to your installation’s API URL, normally on port 50255, and authenticate with an identity permitted to inspect the selected KPI and its dataset. Use the API address confirmed by your administrator, rather than the web application URL normally served over HTTPS on port 443. You need existing native reporting content in the installation.

The 01 Authentication requests save the bearer token for protected requests. If the token expires, authenticate again; the collection does not renew it automatically.

1. Find the intended KPI

In 02 Discover native content, send List KPIs. The KPI array is inside Data. Choose the intended measure, copy its GUID into kpi_id and confirm that its business meaning matches the result you need.

Choose a KPI deliberately. Listing KPIs may require management permissions, even when a reader can view the content.

2. Read the KPI configuration

In 05 KPIs, send Get a KPI configuration. Its script clears the prior cached configuration and stores the returned selected KPI in kpi_configuration after a successful matching response.

Review its dataset, column, aggregation, rounding and units. The calculation request relies on this exact saved configuration. If you change kpi_id, read the new KPI before calculating it.

3. Calculate the native KPI

Send Calculate the selected native KPI. Its pre-request script builds DatasetId, DatasetColumn, AggregateId and the configured RoundingAmount. It checks that the cached configuration belongs to the selected KPI.

The result is a string in Data. Inspect the HTTP status, wrapper error state and returned value. Preserve the string unless your application defines its own numeric and locale conversion rules. Use the result in your application with the KPI’s configured units and rounding.

4. Check the data context

Copy the selected KPI’s DatasetId into dataset_id. In 03 Datasets, send Get a dataset configuration and Get dataset refresh history.

Dataset details are a bare configuration object. Refresh history is a bare array. Check the recorded times and outcome; an empty history is not evidence of a successful refresh. This sequence does not force a refresh or prove that upstream business records have finished loading.

If you also need a related dashboard, inspect Get related dashboards, choose the intended native dashboard ID and set dashboard_id. The 04 Dashboards folder then lets you inspect its configuration and cache timestamp. See data freshness for the distinctions.

5. Make a change only when it serves your next task

The initial workflow is complete once you have retrieved the intended KPI result and checked its data context. The collection also supports these optional next steps:

• Update the selected KPI goal: Read a fresh KPI configuration, set kpi_goal and submit the update. The script preserves the fetched model and changes Goal. Read the KPI again to verify the result. Coordinate with other editors.
• Create a canvas for an existing group: Set canvas_name, dashboard_id, kpi_id and group_id. The request creates a canvas, captures canvas_id and lets you read it back. Verify underlying content permissions and the reader experience separately.

These requests change configuration. Reconcile uncertain outcomes before repeating them. A KPI goal does not automatically configure an alert, and a canvas assignment does not enforce customer-data isolation.

If a request fails

An unresolved or empty variable usually means the matching environment or prerequisite request is missing. A “get the selected KPI configuration again” message means the cache is absent or belongs to another KPI. Authentication, permission, licensing, query and connection failures need investigation at their respective layers.

Use request and response handling and troubleshooting. Keep cached definitions and tokens out of shared exports.