Using Boomi API Insights: A Step-by-Step Guide

Boomi provides API Insights, allowing you to monitor your integration runtime environments programmatically. From CPU and memory usage to worker counts and execution metrics, you can access telemetry data through the Insights API and integrate it into dashboards or monitoring tools.

This guide is split into two parts:

1. Retrieving your Boomi Public API Key

2. Accessing telemetry data using Postman

---

Part 1: Retrieving the Boomi Insights Public API Key

Before querying Boomi Insights APIs, you need an API Token and a Public API Key.

1. Generate an API Token

1. Log in to your Boomi account.

2. Go to Settings → User Profile.

3. In the left pane, click Platform API Tokens.

4. Generate a new token linked to your user account.

2. Access Boomi Insights

1. Navigate to Boomi Insights (region-specific URL).

2. Enter the following when prompted:

   • Account ID (where the token was created)

   • Username (associated with the token)

   • API Token

3. Get the Public API Key

1. Go to Managed Cloud Services → Runtime Dashboard.

2. Select your runtime stack.

3. Click Settings → Public API Settings.

4. Click Get API Key to retrieve it.

⚠️ Note: You must have the Boomi Insights Admin role to access the Public API Key.

---

Part 2: Accessing Insights Data Using Postman

Once you have the Public API Key, you can query telemetry metrics. Use a generic Postman collection with environment variables for easy configuration.

Generic API Endpoints

Metric	Endpoint	Description
CPU Usage	/telemetry?widget=cpu.utilisation.%25&stackname=YourStack	Shows CPU utilization
Memory Usage	/telemetry?widget=ram.used.%25&stackname=YourStack	Tracks memory consumption
Worker Count	/telemetry?widget=boomi.aw.count&stackname=YourStack	Returns the number of active workers
Worker Execution Count	/telemetry?widget=boomi.awExec.count&stackname=YourStack	Shows worker executions