Access Boomi Insights via Postman: Ready-to-Use Collection

Following our previous guide on retrieving your Boomi Public API Key, this post shows how to set up a Postman collection and environment to query telemetry metrics from Boomi Insights.

Using Postman allows you to test APIs, explore available widgets, and integrate metrics into dashboards or automation scripts.

---

Step 1: Import the Collection and Environment

1. Download the files:

   • 📑 Boomi_Insights_Collection.postman_collection.json

   • 🌍 Boomi_Insights_Env.postman_environment.json

2. Open Postman, then import both files.

3. Select the imported environment in the top-right corner.

---

Step 2: Configure Environment Variables

The environment uses three key variables:

Variable	Description
API_KEY	Your Boomi Public API Key 🔑
STACK	Your runtime stack name 🏗️
REGION_GATEWAY	Your Boomi region gateway 🌐 (e.g., us-east-prod-gateway)

💡 Tip: Updating these once applies them to all requests in the collection.

---

Step 3: Example Requests in the Collection

Name	Method	Description
CPU Metrics	GET	Fetches CPU utilization percentage for the stack
Memory Metrics	GET	Returns RAM usage percentage
Worker Count	GET	Number of active workers in the stack
Worker Execution Count	GET	Total executions by workers
List Widgets	GET	Retrieve all available telemetry widgets

Each request uses environment variables to keep URLs and API keys generic and reusable. Sample Request Structure All requests follow the same pattern: Endpoint URL: Uses REGION_GATEWAY and STACK variables Header: x-api-key uses API_KEY variable ⚡ Note: The {{VARIABLE}} syntax pulls values from your Postman environment, making it easy to switch stacks or regions. Step 4: Benefits of Using This Collection Test multiple endpoints quickly without manual URL edits Easily switch between runtime stacks or regions Standardize metrics collection across your team Serve as a foundation for dashboards or automated reporting

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