Business Engine API (3.6.0)

Download OpenAPI specification:Download

Business Intelligence for Grafana.

Documentation

License

Get License Info

Authorizations:

Authorization

Responses

Response samples

200
403
404
500

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

Payload

Content type

application/json

{"token": "string"
}

Response samples

200
400
403
500

Content type

application/json

{"token": "string",
"info": {"limit": 0,
"used": 0,
"expiration": 0,
"isCommunity": true
}
}

Clustering

Get node configuration

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

{"isScaled": false
}

Get Load Balancing

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{"id": "string",
"alertIds": ["string"
],
"reportIds": ["string"
]
}
]

Health

Health check

Authorizations:

Authorization

Responses

Response samples

200
400
403
500

Content type

application/json

{"message": "pong",
"version": "3.6.0"
}

Grafana

Get dashboard variables

Authorizations:

Authorization

Request Body schema: application/json
required

dashboardId required	string
required	object
	object (VariablesTimeRange)

Responses

Request samples

Payload

Content type

application/json

{"dashboardId": "string",
"variables": {"property1": "string",
"property2": "string"
},
"timeRange": {"from": 0,
"to": 0
}
}

Response samples

200
400
403
500

Content type

application/json

{"options": {"property1": {"label": "string",
"value": "string"
},
"property2": {"label": "string",
"value": "string"
}
}
}

Check Panel Support

Authorizations:

Authorization

Request Body schema: application/json
required

dashboardId required	string Dashboard Id
panelId required	number Panel Id

Responses

Request samples

Payload

Content type

application/json

{"dashboardId": "string",
"panelId": 0
}

Response samples

200
400
403
404
500

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

Payload

Content type

application/json

{"timeRange": {"from": 0,
"to": 0
},
"variables": {"property1": "string",
"property2": "string"
},
"dashboardId": "string",
"panelId": 0
}

Response samples

200
403
500

Content type

application/json

"string"

Grafana Proxy

Search dashboards

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{ }
]

Get dashboard by uid

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
500

Content type

application/json

{ }

Get all users within the current organization.

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{ }
]

Reports

Get all reports

Authorizations:

Authorization

query Parameters

limit	number
ids	Array of strings

Responses

Response samples

200
403
500

Content type

application/json

[{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}
]

Create report

Authorizations:

Authorization

Request Body schema: application/json
required

id required	string
dashboardId required	string
timeRangeSource required	string Enum: "dashboard" "configured"
	object (ReportTimeRange)
title required	string
schedule required	string
status required	string Enum: "active" "paused"
variables required	object
actionIds required	Array of strings
event required	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}

Response samples

200
400
403
500

Content type

application/json

{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}

Update report

Authorizations:

Authorization

path Parameters

id

required

any

Request Body schema: application/json
required

id required	string
dashboardId required	string
timeRangeSource required	string Enum: "dashboard" "configured"
	object (ReportTimeRange)
title required	string
schedule required	string
status required	string Enum: "active" "paused"
variables required	object
actionIds required	Array of strings
event required	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}

Response samples

200
400
403
404
500

Content type

application/json

{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}

Delete report

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
404
500

Content type

application/json

true

Get report by id

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
500

Content type

application/json

[{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}
]

Update report status

Authorizations:

Authorization

path Parameters

id

required

any

Request Body schema: application/json
required

status

required

string

Enum: "active" "paused"

Responses

Request samples

Payload

Content type

application/json

{"status": "active"
}

Response samples

200
400
403
404
500

Content type

application/json

{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}

Get events

Authorizations:

Authorization

query Parameters

page	number
limit	number
ids	Array of strings

Responses

Response samples

200
403
500

Content type

application/json

{"pagination": {"page": 0,
"total": 0
},
"data": [{"id": "string",
"date": "2019-08-24T14:15:22Z",
"dashboardId": "string",
"reportTitle": "string",
"reportId": "string",
"file": "string"
}
]
}

Get latest events

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{"id": "string",
"date": "2019-08-24T14:15:22Z",
"dashboardId": "string",
"reportTitle": "string",
"reportId": "string",
"file": "string"
}
]

Get event for report by id

Authorizations:

Authorization

path Parameters

eventId

required

any

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": "string",
"date": "2019-08-24T14:15:22Z",
"dashboardId": "string",
"reportTitle": "string",
"reportId": "string",
"file": "string"
}

Alert Rules

Get all alert rules

Authorizations:

Authorization

query Parameters

limit	number
ids	Array of strings

Responses

Response samples

200
403
500

Content type

application/json

[{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
}
]

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

Payload

Content type

application/json

{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true
}

Response samples

200
400
403
500

Content type

application/json

{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"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

Payload

Content type

application/json

{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true
}

Response samples

200
400
403
404
500

Content type

application/json

{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"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

200
403
404
500

Content type

application/json

true

Get alert rule by id

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
500

Content type

application/json

[{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
}
]

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

Payload

Content type

application/json

{"status": "active"
}

Response samples

200
400
403
404
500

Content type

application/json

{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"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

200
403
404
500

Content type

application/json

{"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
}

Get latest events

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
}
]

Get events timeline

Authorizations:

Authorization

query Parameters

page	number
limit	number
ids	Array of strings

Responses

Response samples

200
403
500

Content type

application/json

{"pagination": {"page": 0,
"total": 0
},
"data": [{"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
}
]
}

Get event for alert rule by id

Authorizations:

Authorization

path Parameters

eventId

required

any

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
}

Get alert rule data preview

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
500

Content type

application/json

[{"query": {"from": "string",
"to": "string",
"queries": [{ }
]
},
"repeat": "string",
"error": true,
"errorDetails": { },
"fieldConfig": { },
"variables": [{ }
],
"series": [{ }
]
}
]

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

Payload

Content type

application/json

{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
]
}

Response samples

200
403
500

Content type

application/json

[{"query": {"from": "string",
"to": "string",
"queries": [{ }
]
},
"repeat": "string",
"error": true,
"errorDetails": { },
"fieldConfig": { },
"variables": [{ }
],
"series": [{ }
]
}
]

Get alert state transition

Authorizations:

Authorization

path Parameters

stateId

required

any

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": "string",
"prevState": "scheduled",
"newState": "scheduled",
"durationMs": 0,
"totalEvents": 0,
"startDate": "string",
"endDate": "string",
"lastEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
}
}

Get alert state transition events

Authorizations:

Authorization

path Parameters

stateId

required

any

query Parameters

page	number
limit	number

Responses

Response samples

200
403
500

Content type

application/json

{"pagination": {"page": 0,
"total": 0
},
"data": [{"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
}
]
}

Environment Management

Get Environment Info

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

{"main": {"serverPort": 0,
"schedulerPort": 0,
"rendererPort": 0,
"nodeId": "string",
"logLevel": "log",
"apiDocumentation": true
},
"processing": {"jobBatchSize": 0,
"alertConditionsBatchSize": 0,
"alertAnnotationsBatchSize": 0,
"alertEventsRetentionDays": 0,
"actionEventsRetentionDays": 0,
"reportEventsRetentionDays": 0
},
"grafana": {"url": "http://localhost:3000",
"healthCheckTimeout": 0,
"healthCheckRetry": 0,
"requestTimeout": 0,
"version": "string",
"rendererAuthType": "",
"rendererBasicAuth": {"username": "string"
}
},
"database": {"host": "localhost",
"port": 5432,
"username": "string",
"db": "string"
}
}

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

Payload

Content type

application/json

{"url": "http://localhost:3000",
"healthCheckTimeout": 0,
"healthCheckRetry": 0,
"requestTimeout": 0,
"version": "string",
"rendererAuthType": "",
"rendererBasicAuth": {"username": "string",
"password": "string"
},
"token": "string"
}

Response samples

200
400

Content type

application/json

{"main": {"serverPort": 0,
"schedulerPort": 0,
"rendererPort": 0,
"nodeId": "string",
"logLevel": "log",
"apiDocumentation": true
},
"processing": {"jobBatchSize": 0,
"alertConditionsBatchSize": 0,
"alertAnnotationsBatchSize": 0,
"alertEventsRetentionDays": 0,
"actionEventsRetentionDays": 0,
"reportEventsRetentionDays": 0
},
"grafana": {"url": "http://localhost:3000",
"healthCheckTimeout": 0,
"healthCheckRetry": 0,
"requestTimeout": 0,
"version": "string",
"rendererAuthType": "",
"rendererBasicAuth": {"username": "string"
}
},
"database": {"host": "localhost",
"port": 5432,
"username": "string",
"db": "string"
}
}

Update Processing Environment

Authorizations:

Authorization

Request Body schema: application/json
required

jobBatchSize required	number
alertConditionsBatchSize required	number
alertAnnotationsBatchSize required	number
alertEventsRetentionDays required	number
actionEventsRetentionDays required	number
reportEventsRetentionDays required	number

Responses

Request samples

Payload

Content type

application/json

{"jobBatchSize": 0,
"alertConditionsBatchSize": 0,
"alertAnnotationsBatchSize": 0,
"alertEventsRetentionDays": 0,
"actionEventsRetentionDays": 0,
"reportEventsRetentionDays": 0
}

Response samples

200

Content type

application/json

{"main": {"serverPort": 0,
"schedulerPort": 0,
"rendererPort": 0,
"nodeId": "string",
"logLevel": "log",
"apiDocumentation": true
},
"processing": {"jobBatchSize": 0,
"alertConditionsBatchSize": 0,
"alertAnnotationsBatchSize": 0,
"alertEventsRetentionDays": 0,
"actionEventsRetentionDays": 0,
"reportEventsRetentionDays": 0
},
"grafana": {"url": "http://localhost:3000",
"healthCheckTimeout": 0,
"healthCheckRetry": 0,
"requestTimeout": 0,
"version": "string",
"rendererAuthType": "",
"rendererBasicAuth": {"username": "string"
}
},
"database": {"host": "localhost",
"port": 5432,
"username": "string",
"db": "string"
}
}

Update Environment Name

Authorizations:

Authorization

Request Body schema: application/json
required

name

required

string

Environment Name

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400

Content type

application/json

{"name": "string"
}

Transfer

Export Engine Configuration

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{"version": "string",
"alerts": [{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
}
],
"reports": [{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}
],
"actions": [{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string",
"id": "string",
"latestEvent": {"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
},
"useFor": ["string"
],
"useForReports": ["string"
]
}
]
}
]

Import Engine Configuration

Authorizations:

Authorization

Request Body schema: application/json
required

version required	string
required	Array of objects (ResponseAlert)
required	Array of objects (Report)
required	Array of objects (ResponseAction)

Responses

Request samples

Payload

Content type

application/json

{"version": "string",
"alerts": [{"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
}
],
"reports": [{"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
}
],
"actions": [{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string",
"id": "string",
"latestEvent": {"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
},
"useFor": ["string"
],
"useForReports": ["string"
]
}
]
}

Response samples

200
400
403
422
500

Content type

application/json

true

Actions

Get all actions

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string",
"id": "string",
"latestEvent": {"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
},
"useFor": ["string"
],
"useForReports": ["string"
]
}
]

Create action

Authorizations:

Authorization

Request Body schema: application/json
required

title required	string
type required	string Enum: "request" "custom"
target required	string Enum: "alerting" "reporting"
required	ActionRequestOptions (object) or ActionCustomOptions (object)
message required	string

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string"
}

Response samples

200
400
403
500

Content type

application/json

{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string",
"id": "string",
"latestEvent": {"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
},
"useFor": ["string"
],
"useForReports": ["string"
]
}

Get action events

Authorizations:

Authorization

query Parameters

page	number
limit	number
alertStateId	string Alert State Transition Id
eventId	string Event Id
alertId	string Alert Id
ids	Array of strings Action Ids

Responses

Response samples

200
403
500

Content type

application/json

{"pagination": {"page": 0,
"total": 0
},
"data": [{"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
}
]
}

Get action report events

Authorizations:

Authorization

query Parameters

page	number
limit	number
eventId	string Event Id
reportId	string Report Id
ids	Array of strings Action Ids

Responses

Response samples

200
403
500

Content type

application/json

{"pagination": {"page": 0,
"total": 0
},
"data": [{"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
}
]
}

Update action

Authorizations:

Authorization

path Parameters

id

required

any

Request Body schema: application/json
required

title required	string
type required	string Enum: "request" "custom"
target required	string Enum: "alerting" "reporting"
required	ActionRequestOptions (object) or ActionCustomOptions (object)
message required	string

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string"
}

Response samples

200
400
403
500

Content type

application/json

{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string",
"id": "string",
"latestEvent": {"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
},
"useFor": ["string"
],
"useForReports": ["string"
]
}

Delete action

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
400
403
500

Content type

application/json

true

Get action by id

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
500

Content type

application/json

{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string",
"id": "string",
"latestEvent": {"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
},
"useFor": ["string"
],
"useForReports": ["string"
]
}

Test action

Authorizations:

Authorization

Request Body schema: application/json
required

title required	string
type required	string Enum: "request" "custom"
target required	string Enum: "alerting" "reporting"
required	ActionRequestOptions (object) or ActionCustomOptions (object)
message required	string

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"type": "request",
"target": "alerting",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"message": "string"
}

Response samples

200
403
500
502

Content type

application/json

{"ok": true,
"message": "string"
}

Get action by id

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
500

Content type

application/json

{"id": "string",
"date": "string",
"alert": {"status": "active",
"dashboardId": "string",
"panelId": 0,
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"condition": {"id": "string",
"repeat": "string",
"variables": {"property1": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
},
"property2": {"name": "string",
"multi": true,
"includeAll": true,
"value": "string"
}
},
"evaluationType": "anomaly",
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"evaluationApply": {"mode": "all",
"percentage": 0
}
},
"conditionOverrides": [{"id": "string",
"isDisabled": true,
"evaluation": {"field": "string",
"pattern": "string",
"type": "pattern"
},
"variables": {"property1": "string",
"property2": "string"
}
}
],
"title": "string",
"sampleSize": 0,
"noDataState": "scheduled",
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"isConfigurationValid": true,
"screenshots": true,
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
},
"alertEvent": {"id": "string",
"alertId": "string",
"startDate": "string",
"endDate": "string",
"event": { },
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string",
"stateId": "string"
},
"condition": { },
"message": "string",
"status": "ok",
"error": { }
}

Get action by id

Authorizations:

Authorization

path Parameters

id

required

any

Responses

Response samples

200
403
500

Content type

application/json

{"id": "string",
"date": "string",
"report": {"id": "string",
"dashboardId": "string",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"title": "string",
"schedule": "string",
"status": "active",
"variables": { },
"actionIds": ["string"
],
"event": { }
},
"reportEvent": {"id": "string",
"date": "2019-08-24T14:15:22Z",
"dashboardId": "string",
"reportTitle": "string",
"reportId": "string",
"file": "string"
},
"message": "string",
"status": "ok",
"error": { }
}

Business Engine API (3.6.0)

License

Get License Info

Authorizations:

Responses

Response samples

Update License Token

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Clustering

Get node configuration

Authorizations:

Responses

Response samples

Get Load Balancing

Authorizations:

Responses

Response samples

Health

Health check

Authorizations:

Responses

Response samples

Grafana

Get dashboard variables

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Check Panel Support

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Take Panel Screenshot

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Grafana Proxy

Search dashboards

Authorizations:

Responses

Response samples

Get dashboard by uid

Authorizations:

path Parameters

Responses

Response samples

Get all users within the current organization.

Authorizations:

Responses

Response samples

Reports

Get all reports

Authorizations:

query Parameters

Responses

Response samples

Create report

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update report

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete report

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required