Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Instana Business Monitoring API

The Business Monitoring API from Instana — 5 operation(s) for business monitoring.

Instana Business Monitoring API is one of 62 APIs that Instana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Business Monitoring. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 1.307.1417.

Requests are made against 2 base URLs: https://{unit}-{tenant}.instana.io, https://{domain}.

8 operations 5 paths 15 schemas 1 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.307.1417
Servers
https://{unit}-{tenant}.instana.io
https://{domain}
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Instana Business Monitoring API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (ApiKeyAuth).

  • ApiKeyAuth — Example bash curl --request GET \ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \ --header 'authorization: apiToken xxxxxxxx…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Business Monitoring 8
POST
/api/business-monitoring/activities
Get Business Activities
getActivities body → 200
POST
/api/business-monitoring/activities/csv
Download Business Activities
getActivitiesCsv body → 200
GET
/api/business-monitoring/business-perspectives
Get all business perspectives
getBusinessPerspectives → 200
POST
/api/business-monitoring/business-perspectives
Create business perspective
createBusinessPerspective body → 200
DELETE
/api/business-monitoring/business-perspectives/{id}
Delete business perspective
deleteBusinessPerspective 1 param → default
GET
/api/business-monitoring/business-perspectives/{id}
Get business perspective
getBusinessPerspective 1 param → 200
PUT
/api/business-monitoring/business-perspectives/{id}
Update business perspective
updateBusinessPerspective 1 param body → 200
GET
/api/business-monitoring/catalog
Get business tag catalog
getBusinessTagCatalog 2 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BusinessActivity (9 properties), Tag (9 properties), TagTreeLevel (7 properties), GetActivities (5 properties). Each schema is shown below with its type and property counts.

BusinessActivity
object
9 properties 1 required
BusinessPerspectiveConfig
object
4 properties 1 required
TagCatalog
object
2 properties 2 required
Pagination
object
2 properties
Order
object
Specifies the ordering of the results. It contains fields that define the sorting criteria, the collation for sorting, and the direction in which the results s…
3 properties 2 required
IngestionOffsetCursor
object
Cursor to use between successive queries
NewBusinessPerspectiveConfig
object
3 properties
Tag
object
List of queryable tags available in a tagTree. Eg: call.erroneous. Consider these tags as attributes of a tagTree. Eg: Call tagTree has have Erroneous, Call na…
9 properties 2 required
TagTreeNode
object
Children tags of tagTree
3 properties
CursorPaginatedBusinessActivityItem
object
3 properties 1 required
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
TagTreeLevel
object
The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: Call. Consider this as the root of the tree where i…
7 properties 2 required
TimeFrame
object
Time range for which the data should be retrieved.
2 properties
GetActivities
object
5 properties 3 required
UpdatedBusinessPerspectiveConfig
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-business-monitoring-api-openapi.yml Raw ↑

Other APIs Instana publishes across the network.

Instana Action Catalog API
Instana Action History API
Instana AI Management API
Instana Apdex Report API
Instana Apdex Settings API
Instana API Token API
Instana Application Alert Configuration API
Instana Application Analyze API
Instana Application Catalog API
Instana Application Metrics API
Instana Application Resources API
Instana Application Settings API