Business Engine API (2.1.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
}

Health

Health check

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

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

Alert Rules

Get all alert rules

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{"status": "active",
"title": "string",
"dashboardId": "string",
"panelId": 0,
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"conditions": [{"id": "string",
"repeat": "string",
"type": "global",
"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
}
}
],
"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"
title required	string
dashboardId required	string
panelId required	number
schedule required	string
actionIds required	Array of strings
annotations required	string Enum: "panel" "dashboard" "disabled"
timeRangeSource required	string Enum: "dashboard" "configured"
	object (AlertTimeRange)
required	array

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"title": "string",
"dashboardId": "string",
"panelId": 0,
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"conditions": [{"id": "string",
"repeat": "string",
"type": "global",
"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
}
}
]
}

Response samples

200
400
403
500

Content type

application/json

{"status": "active",
"title": "string",
"dashboardId": "string",
"panelId": 0,
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"conditions": [{"id": "string",
"repeat": "string",
"type": "global",
"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
}
}
],
"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"
title required	string
dashboardId required	string
panelId required	number
schedule required	string
actionIds required	Array of strings
annotations required	string Enum: "panel" "dashboard" "disabled"
timeRangeSource required	string Enum: "dashboard" "configured"
	object (AlertTimeRange)
required	array

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"title": "string",
"dashboardId": "string",
"panelId": 0,
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"conditions": [{"id": "string",
"repeat": "string",
"type": "global",
"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
}
}
]
}

Response samples

200
400
403
404
500

Content type

application/json

{"status": "active",
"title": "string",
"dashboardId": "string",
"panelId": 0,
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"conditions": [{"id": "string",
"repeat": "string",
"type": "global",
"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
}
}
],
"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",
"title": "string",
"dashboardId": "string",
"panelId": 0,
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"conditions": [{"id": "string",
"repeat": "string",
"type": "global",
"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
}
}
],
"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",
"title": "string",
"dashboardId": "string",
"panelId": 0,
"schedule": "string",
"actionIds": ["string"
],
"annotations": "panel",
"timeRangeSource": "dashboard",
"timeRange": {"from": 0,
"to": 0
},
"conditions": [{"id": "string",
"repeat": "string",
"type": "global",
"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
}
}
],
"id": "string",
"stateStartDate": "2019-08-24T14:15:22Z"
}

Get last history 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": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"event": "string",
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string"
}

Get all history events

Authorizations:

Authorization

query Parameters

limit	number
ids	Array of strings

Responses

Response samples

200
403
500

Content type

application/json

[{"id": "string",
"alertId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"event": "string",
"prevState": "scheduled",
"newState": "scheduled",
"duration": 0,
"alertTitle": "string"
}
]

Grafana Variables

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"
}
}
}

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

[{ }
]

Actions

Get all actions

Authorizations:

Authorization

Responses

Response samples

200
403
500

Content type

application/json

[{"title": "string",
"type": "request",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"isDefault": true,
"message": "string",
"id": "string",
"useFor": ["string"
],
"useForByDefault": ["string"
]
}
]

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)
isDefault	boolean
message required	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
500

Content type

application/json

{"title": "string",
"type": "request",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"isDefault": true,
"message": "string",
"id": "string",
"useFor": ["string"
],
"useForByDefault": ["string"
]
}

Get default action

Authorizations:

Authorization

Responses

Response samples

200
403
404
500

Content type

application/json

{"title": "string",
"type": "request",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"isDefault": true,
"message": "string",
"id": "string",
"useFor": ["string"
],
"useForByDefault": ["string"
]
}

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)
isDefault	boolean
message required	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
500

Content type

application/json

{"title": "string",
"type": "request",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"isDefault": true,
"message": "string",
"id": "string",
"useFor": ["string"
],
"useForByDefault": ["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",
"options": {"url": "string",
"headers": [{"key": "string",
"value": "string"
}
]
},
"isDefault": true,
"message": "string",
"id": "string",
"useFor": ["string"
],
"useForByDefault": ["string"
]
}

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)
isDefault	boolean
message required	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
403
500
502

Content type

application/json

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

Prometheus Metrics

Get prometheus metrics

Responses

Response samples

200

Content type

application/json

"string"

Business Engine API (2.1.0)

License

Get license info

Authorizations:

Responses

Response samples

Health

Health check

Authorizations:

Responses

Response samples

Alert Rules

Get all alert rules

Authorizations:

Responses

Response samples

Create alert rule

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update alert rule

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete alert rule

Authorizations:

path Parameters

Responses

Response samples

Get alert rule by id

Authorizations:

path Parameters

Responses

Response samples

Update alert rule status

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get last history event for alert rule

Authorizations:

path Parameters

Responses

Response samples

Get all history events

Authorizations:

query Parameters

Responses

Response samples

Grafana Variables

Get dashboard variables

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

Actions

Get all actions

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