Documentation Index

Fetch the complete documentation index at: https://docs.turbo360.com/llms.txt

Use this file to discover all available pages before exploring further.

Business Activity Monitoring API reference

Prev Next

Overview

The Business Activity Monitoring (BAM) APIs provide programmatic access to core BAM resources — business processes, transactions, tracking, and service principals. Use these APIs to integrate BAM data into external systems, automate configuration, and build custom workflows that extend BAM capabilities beyond the Turbo360 portal.

Business value

The BAM APIs let development teams automate transaction management, query tracking data, and manage service principals without portal access. This reduces operational overhead, enables CI/CD integration for BAM configuration, and supports custom monitoring pipelines.

How it works

All BAM API requests are authenticated using a bearer token. Pass the token in the Authorization header of every request. Authentication is enforced on all endpoints (indicated by the lock icon in the API reference).

The base URL for all API requests is your Turbo360 portal URL:

  • Cloud-hosted: https://portal.turbo360.com
  • Private hosting: Use the URL of your self-hosted Turbo360 instance.

Include your bearer token in the request header:

Authorization: Bearer <your-token>

You can explore and test all available endpoints using the Swagger UI at <your-portal-url>/swagger/index.html.

For full authentication setup, see Authentication.

Endpoint reference

BusinessActivityMonitoring - ServicePrincipal

Operations for managing the service principals used by BAM data queries.

Method Endpoint Description
GET /BusinessActivityMonitoring/DataQueries/ServicePrincipal/Get Get the service principals
POST /BusinessActivityMonitoring/DataQueries/ServicePrincipal/Add Add a new service principal
DELETE /BusinessActivityMonitoring/DataQueries/ServicePrincipal/Remove Remove a service principal
PUT /BusinessActivityMonitoring/DataQueries/ServicePrincipal/Update Update an existing service principal

BusinessActivityMonitoring - Tracking

Operations for querying and managing transaction instances.

Method Endpoint Description
GET /BusinessActivityMonitoring/{businessProcessId}/Tracking/GetInstances Get transaction instances — max 1000
GET /BusinessActivityMonitoring/Tracking/GetTransactionInstances Get transaction instances by transaction ID — ordered by StartedAt DESC
GET /BusinessActivityMonitoring/Tracking/GetTransactionInstanceDetails Get transaction instance details along with its stage instances
POST /BusinessActivityMonitoring/{businessProcessId}/Tracking/DefaultStageReprocess Reprocess the transaction instances
PUT /BusinessActivityMonitoring/{businessProcessId}/Tracking/UpdateInstanceStatus Update status of transaction instances

BusinessActivityMonitoring - Transactions

Operations for creating and managing business transactions and their configuration.

Method Endpoint Description
GET /BusinessActivityMonitoring/BusinessTransaction/{businessTransactionId}/Get Get a business transaction
POST /BusinessActivityMonitoring/BusinessTransaction/Create Create a new business transaction
PUT /BusinessActivityMonitoring/BusinessTransaction/Update Update an existing business transaction
DELETE /BusinessActivityMonitoring/BusinessTransaction/Delete Delete a business transaction
PUT /BusinessActivityMonitoring/BusinessTransaction/Export Export custom logging business transactions
PUT /BusinessActivityMonitoring/DataQueries/BusinessTransaction/Export Export data queries business transactions
POST /BusinessActivityMonitoring/BusinessTransaction/Import Import custom logging business transactions
POST /BusinessActivityMonitoring/DataQueries/BusinessTransaction/Import Import data queries business transactions
GET /BusinessActivityMonitoring/BusinessTransaction/{businessTransactionId}/GetStages Get the stages of a business transaction

Related articles