Skip to main content
API docs by Redocly

Business Engine API (3.5.0)

Download OpenAPI specification:Download

Business Intelligence for Grafana.

Documentation

License

Get License Info

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "used": 0,
  • "expiration": 0,
  • "isCommunity": true
}

Update License Token

Authorizations:
Authorization
Request Body schema: application/json
required
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "info": {
    }
}

Clustering

Get node configuration

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "isScaled": false
}

Get Load Balancing

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Health

Health check

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "message": "pong",
  • "version": "3.5.0"
}

Grafana

Get dashboard variables

Authorizations:
Authorization
Request Body schema: application/json
required
dashboardId
required
string
required
object
object (VariablesTimeRange)

Responses

Request samples

Content type
application/json
{
  • "dashboardId": "string",
  • "variables": {
    },
  • "timeRange": {
    }
}

Response samples

Content type
application/json
{
  • "options": {
    }
}

Check Panel Support

Authorizations:
Authorization
Request Body schema: application/json
required
dashboardId
required
string

Dashboard Id

panelId
required
number

Panel Id

Responses

Request samples

Content type
application/json
{
  • "dashboardId": "string",
  • "panelId": 0
}

Response samples

Content type
application/json
true

Take Panel Screenshot

Authorizations:
Authorization
Request Body schema: application/json
required
object (AbsoluteTimeRange)
object
dashboardId
required
string

Dashboard Id

panelId
required
number

Panel Id

Responses

Request samples

Content type
application/json
{
  • "timeRange": {
    },
  • "variables": {
    },
  • "dashboardId": "string",
  • "panelId": 0
}

Response samples

Content type
application/json
"string"

Grafana Proxy

Search dashboards

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • { }
]

Get dashboard by uid

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
{ }

Get all users within the current organization.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • { }
]

Alert Rules

Get all alert rules

Authorizations:
Authorization
query Parameters
limit
number
ids
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create alert rule

Authorizations:
Authorization
Request Body schema: application/json
required
status
required
string
Enum: "active" "paused"
dashboardId
required
string
panelId
required
number
timeRangeSource
required
string
Enum: "dashboard" "configured"
object (AlertTimeRange)
required
object (AlertCondition)
required
Array of objects (AlertConditionOverride)
title
required
string
sampleSize
required
number
noDataState
required
string
Enum: "scheduled" "ok" "alerting" "error"
schedule
required
string
actionIds
required
Array of strings
annotations
required
string
Enum: "panel" "dashboard" "disabled"
isConfigurationValid
required
boolean
screenshots
required
boolean

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "dashboardId": "string",
  • "panelId": 0,
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "condition": {
    },
  • "conditionOverrides": [
    ],
  • "title": "string",
  • "sampleSize": 0,
  • "noDataState": "scheduled",
  • "schedule": "string",
  • "actionIds": [
    ],
  • "annotations": "panel",
  • "isConfigurationValid": true,
  • "screenshots": true
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "dashboardId": "string",
  • "panelId": 0,
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "condition": {
    },
  • "conditionOverrides": [
    ],
  • "title": "string",
  • "sampleSize": 0,
  • "noDataState": "scheduled",
  • "schedule": "string",
  • "actionIds": [
    ],
  • "annotations": "panel",
  • "isConfigurationValid": true,
  • "screenshots": true,
  • "id": "string",
  • "stateStartDate": "2019-08-24T14:15:22Z"
}

Update alert rule

Authorizations:
Authorization
path Parameters
id
required
any
Request Body schema: application/json
required
status
required
string
Enum: "active" "paused"
dashboardId
required
string
panelId
required
number
timeRangeSource
required
string
Enum: "dashboard" "configured"
object (AlertTimeRange)
required
object (AlertCondition)
required
Array of objects (AlertConditionOverride)
title
required
string
sampleSize
required
number
noDataState
required
string
Enum: "scheduled" "ok" "alerting" "error"
schedule
required
string
actionIds
required
Array of strings
annotations
required
string
Enum: "panel" "dashboard" "disabled"
isConfigurationValid
required
boolean
screenshots
required
boolean

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "dashboardId": "string",
  • "panelId": 0,
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "condition": {
    },
  • "conditionOverrides": [
    ],
  • "title": "string",
  • "sampleSize": 0,
  • "noDataState": "scheduled",
  • "schedule": "string",
  • "actionIds": [
    ],
  • "annotations": "panel",
  • "isConfigurationValid": true,
  • "screenshots": true
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "dashboardId": "string",
  • "panelId": 0,
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "condition": {
    },
  • "conditionOverrides": [
    ],
  • "title": "string",
  • "sampleSize": 0,
  • "noDataState": "scheduled",
  • "schedule": "string",
  • "actionIds": [
    ],
  • "annotations": "panel",
  • "isConfigurationValid": true,
  • "screenshots": true,
  • "id": "string",
  • "stateStartDate": "2019-08-24T14:15:22Z"
}

Delete alert rule

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
true

Get alert rule by id

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update alert rule status

Authorizations:
Authorization
path Parameters
id
required
any
Request Body schema: application/json
required
status
required
string
Enum: "active" "paused"

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "dashboardId": "string",
  • "panelId": 0,
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "condition": {
    },
  • "conditionOverrides": [
    ],
  • "title": "string",
  • "sampleSize": 0,
  • "noDataState": "scheduled",
  • "schedule": "string",
  • "actionIds": [
    ],
  • "annotations": "panel",
  • "isConfigurationValid": true,
  • "screenshots": true,
  • "id": "string",
  • "stateStartDate": "2019-08-24T14:15:22Z"
}

Get last event for alert rule

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "alertId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "event": { },
  • "prevState": "scheduled",
  • "newState": "scheduled",
  • "duration": 0,
  • "alertTitle": "string"
}

Get latest events

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get events timeline

Authorizations:
Authorization
query Parameters
page
number
limit
number
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get event for alert rule by id

Authorizations:
Authorization
path Parameters
eventId
required
any

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "alertId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "event": { },
  • "prevState": "scheduled",
  • "newState": "scheduled",
  • "duration": 0,
  • "alertTitle": "string"
}

Get alert rule data preview

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview for alert on configuration stage

Authorizations:
Authorization
Request Body schema: application/json
required
status
required
string
Enum: "active" "paused"
dashboardId
required
string
panelId
required
number
timeRangeSource
required
string
Enum: "dashboard" "configured"
object (AlertTimeRange)
required
object (AlertCondition)
required
Array of objects (AlertConditionOverride)

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "dashboardId": "string",
  • "panelId": 0,
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "condition": {
    },
  • "conditionOverrides": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Environment Management

Get Environment Info

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "main": {
    },
  • "processing": {
    },
  • "grafana": {
    },
  • "database": {
    }
}

Update Grafana Environment

Authorizations:
Authorization
Request Body schema: application/json
required
url
required
string
healthCheckTimeout
required
number
healthCheckRetry
required
number
requestTimeout
required
number
version
required
string
rendererAuthType
required
string
Enum: "" "basic"
required
object (EnvironmentGrafanaRendererBasicAuthToUpdate)
token
required
string

Grafana service account token

Responses

Request samples

Content type
application/json
{
  • "url": "http://localhost:3000",
  • "healthCheckTimeout": 0,
  • "healthCheckRetry": 0,
  • "requestTimeout": 0,
  • "version": "string",
  • "rendererAuthType": "",
  • "rendererBasicAuth": {
    },
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "main": {
    },
  • "processing": {
    },
  • "grafana": {
    },
  • "database": {
    }
}

Update Processing Environment

Authorizations:
Authorization
Request Body schema: application/json
required
alertBatchSize
required
number
alertConditionsBatchSize
required
number
alertAnnotationsBatchSize
required
number
alertEventsRetentionDays
required
number
actionEventsRetentionDays
required
number

Responses

Request samples

Content type
application/json
{
  • "alertBatchSize": 0,
  • "alertConditionsBatchSize": 0,
  • "alertAnnotationsBatchSize": 0,
  • "alertEventsRetentionDays": 0,
  • "actionEventsRetentionDays": 0
}

Response samples

Content type
application/json
{
  • "main": {
    },
  • "processing": {
    },
  • "grafana": {
    },
  • "database": {
    }
}

Update Environment Name

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string

Environment Name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Transfer

Export Engine Configuration

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Import Engine Configuration

Authorizations:
Authorization
Request Body schema: application/json
required
version
required
string
required
Array of objects (ResponseAlert)
required
Array of objects (ResponseAction)

Responses

Request samples

Content type
application/json
{
  • "version": "string",
  • "alerts": [
    ],
  • "actions": [
    ]
}

Response samples

Content type
application/json
true

Actions

Get all actions

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create action

Authorizations:
Authorization
Request Body schema: application/json
required
title
required
string
type
required
string
Enum: "request" "custom"
required
ActionRequestOptions (object) or ActionCustomOptions (object)
message
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "message": "string",
  • "id": "string",
  • "latestEvent": {
    },
  • "useFor": [
    ]
}

Get action events

Authorizations:
Authorization
query Parameters
page
number
limit
number
eventId
string

Event Id

alertId
string

Alert Id

ids
Array of strings

Action Ids

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Update action

Authorizations:
Authorization
path Parameters
id
required
any
Request Body schema: application/json
required
title
required
string
type
required
string
Enum: "request" "custom"
required
ActionRequestOptions (object) or ActionCustomOptions (object)
message
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "message": "string",
  • "id": "string",
  • "latestEvent": {
    },
  • "useFor": [
    ]
}

Delete action

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
true

Get action by id

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "message": "string",
  • "id": "string",
  • "latestEvent": {
    },
  • "useFor": [
    ]
}

Test action

Authorizations:
Authorization
Request Body schema: application/json
required
title
required
string
type
required
string
Enum: "request" "custom"
required
ActionRequestOptions (object) or ActionCustomOptions (object)
message
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "message": "string"
}

Get action by id

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "alert": {
    },
  • "alertEvent": {
    },
  • "condition": { },
  • "message": "string",
  • "status": "ok",
  • "error": { }
}

Prometheus Metrics

MetricsController_index

Responses