Boomi API Execution Response Test

In Boomi, API execution responses refer to the output generated by the integration processes when they are exposed as APIs. Boomi service employs an API component to create an API that exposes the integration process by defining endpoints and methods namely GET, POST, etc.. This test helps the administrators to verify if API response time in Boomi are taking longer than expected.

Target of the test : Boomi Service

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each Response type in the target Boomi Service being monitored

Configurable parameters for the test
Parameter	Description
Test period	How often should the test be executed.
Host	The host for which the test is to be configured.
Port	The port number at which the specified host listens to.
Boomi Platform Base URL	Specify the URL - https://api.boomi.com/ that is used towards user registration for accessing the Boomi console.
Account ID	Specify the user Account ID that is auto-generated while registering the user in Boomi console. To know more, refer to Creating a new user and assigning user role in Boomi console topic in How does eG Enterprise Monitor Boomi AtomSphere? chapter.
Boomi User Account	Specify the email ID of the user in the Boomi User Account text box that is used towards user registration for accessing the Boomi console. To know more, refer to Creating a new user and assigning user role in Boomi console topic in How does eG Enterprise Monitor Boomi AtomSphere? chapter.
API Token	Specify the API token value that was generated using the Boomi console. To know how to generate the API token in Boomi console, refer to Creating a new API token in Boomi console in How does eG Enterprise Monitor Boomi AtomSphere?chapter.
Timeout	Specify the duration (in seconds) for which this test should wait for a response from the target Boomi Service. If there is no response from the target beyond the configured duration, the test will timeout. By default, this is set to 120 seconds.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Average response time	Indicates the average response time taken by the APIs to generate output for the integration process.	Milliseconds	When the average response time of an API increases, it means that Boomi will have to wait longer to receive data or execute operations via external systems. This can result in slower overall performance of the integration process. If Boomi processes multiple API calls, a delay in one can accumulate and slow down the entire flow, leading to prolonged execution times.