Skip to main content
API docs by Redocly

BI(G) HTTP API (1.7.0)

Download OpenAPI specification:Download

Business Intelligence for Grafana simplifies alerting for business users, providing them with an accessible platform.

Documentation

License

Get license info

Authorizations:
Authorization

Responses

Response samples

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

Health

Health check

Authorizations:
Authorization

Responses

Response samples

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

Alert Rules

Get all alert rules

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
webhookIds
required
Array of strings
annotations
required
string
Enum: "panel" "dashboard" "disabled"
timeRangeSource
required
string
Enum: "dashboard" "configured"
object (AlertTimeRange)
required
array

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "title": "string",
  • "dashboardId": "string",
  • "panelId": 0,
  • "schedule": "string",
  • "webhookIds": [
    ],
  • "annotations": "panel",
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "title": "string",
  • "dashboardId": "string",
  • "panelId": 0,
  • "schedule": "string",
  • "webhookIds": [
    ],
  • "annotations": "panel",
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "conditions": [
    ],
  • "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
webhookIds
required
Array of strings
annotations
required
string
Enum: "panel" "dashboard" "disabled"
timeRangeSource
required
string
Enum: "dashboard" "configured"
object (AlertTimeRange)
required
array

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "title": "string",
  • "dashboardId": "string",
  • "panelId": 0,
  • "schedule": "string",
  • "webhookIds": [
    ],
  • "annotations": "panel",
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "active",
  • "title": "string",
  • "dashboardId": "string",
  • "panelId": 0,
  • "schedule": "string",
  • "webhookIds": [
    ],
  • "annotations": "panel",
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "conditions": [
    ],
  • "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

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",
  • "title": "string",
  • "dashboardId": "string",
  • "panelId": 0,
  • "schedule": "string",
  • "webhookIds": [
    ],
  • "annotations": "panel",
  • "timeRangeSource": "dashboard",
  • "timeRange": {
    },
  • "conditions": [
    ],
  • "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

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Grafana Variables

Get dashboard variables

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

Responses

Request samples

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

Response samples

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

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
[
  • { }
]

Webhooks

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
WebhookRequestOptionsDto (object) or WebhookCustomOptionsDto (object)
isDefault
boolean

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "isDefault": true,
  • "id": "string",
  • "useFor": [
    ],
  • "useForByDefault": [
    ]
}

Get default action

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "isDefault": true,
  • "id": "string",
  • "useFor": [
    ],
  • "useForByDefault": [
    ]
}

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
WebhookRequestOptionsDto (object) or WebhookCustomOptionsDto (object)
isDefault
boolean

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "title": "string",
  • "type": "request",
  • "options": {
    },
  • "isDefault": true,
  • "id": "string",
  • "useFor": [
    ],
  • "useForByDefault": [
    ]
}

Delete action

Authorizations:
Authorization
path Parameters
id
required
any

Responses

Response samples

Content type
application/json
true

Test action

Authorizations:
Authorization
Request Body schema: application/json
required
title
required
string
type
required
string
Enum: "request" "custom"
required
WebhookRequestOptionsDto (object) or WebhookCustomOptionsDto (object)
isDefault
boolean

Responses

Request samples

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

Response samples

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

Prometheus Metrics

Get prometheus metrics

Responses

Response samples

Content type
application/json
"string"