Tesmon API (0.0.0)

Download OpenAPI specification:Download

API Support: dev@tesmon.io URL: https://tesmon.io Terms of Service

Introduction

This API is documented in OpenAPI format. In addition to standard OpenAPI syntax we use a few vendor extensions.

Authentication

Tesmon offers below forms of authentication:

API Key

api_key

For this API docs, you can use the api key SIGNOZ-API-KEY to access data.

Security Scheme Type: API Key

Header parameter name: SIGNOZ-API-KEY

alerts

Alerts API

Add a alert rule to the system

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Request Body schema: application/json
required

Alert object that needs to be added to the system

alert required	string Name of the alert
required	AlertType (string) Type of the alert
description	string Description of the alert
required	RuleType (string) Type of the rule
evalWindow	string Evaluation time window (ex - (now-15m, now)) for the alert in parseable format ("15m", "30m" "1h" etc.). Default is 5m.
frequency	string Run frequency of the alert in parseable format ("15m", "30m" "1h" etc.). Default is 1m.
required	object Condition criteria for the alert.
	object Labels kv map for the alert
	object Annotations kv map for the alert
disabled	boolean Whether the alert is disabled or not
source	string Source of the alert where it is created from.
preferredChannels	Array of strings Preferred channels for the alert. If not specified, all the channels will be used. Use the alert channel for this.

Responses

Request samples

Payload

Content type

application/json

{"alert": "string",
"alertType": "LOGS_BASED_ALERT",
"description": "string",
"ruleType": "threshold_rule",
"evalWindow": "string",
"frequency": "string",
"condition": {"target": null,
"matchType": "0",
"op": "0",
"compositeQuery": {"builderQueries": {"<queryName>": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
},
"chQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"promQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"panelType": "graph",
"queryType": "builder"
},
"targetUnit": "string",
"selectedQueryName": "string"
},
"labels": {"key": "string"
},
"annotations": {"key": "string"
},
"disabled": true,
"source": "string",
"preferredChannels": ["string"
]
}

Get all alert rules

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Responses

Response samples

Content type

application/json

{"alert": "string",
"alertType": "LOGS_BASED_ALERT",
"description": "string",
"ruleType": "threshold_rule",
"evalWindow": "string",
"frequency": "string",
"condition": {"target": null,
"matchType": "0",
"op": "0",
"compositeQuery": {"builderQueries": {"<queryName>": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
},
"chQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"promQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"panelType": "graph",
"queryType": "builder"
},
"targetUnit": "string",
"selectedQueryName": "string"
},
"labels": {"key": "string"
},
"annotations": {"key": "string"
},
"disabled": true,
"source": "string",
"preferredChannels": ["string"
]
}

Find alert rule by ID

Returns a single alert rule

path Parameters

required

integer <int64>

ID of alert rule to return

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Responses

Response samples

Content type

application/json

{"alert": "string",
"alertType": "LOGS_BASED_ALERT",
"description": "string",
"ruleType": "threshold_rule",
"evalWindow": "string",
"frequency": "string",
"condition": {"target": null,
"matchType": "0",
"op": "0",
"compositeQuery": {"builderQueries": {"<queryName>": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
},
"chQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"promQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"panelType": "graph",
"queryType": "builder"
},
"targetUnit": "string",
"selectedQueryName": "string"
},
"labels": {"key": "string"
},
"annotations": {"key": "string"
},
"disabled": true,
"source": "string",
"preferredChannels": ["string"
]
}

Update an existing alert rule

path Parameters

required

integer <int64>

ID of alert rule to update

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Request Body schema: application/json
required

Alert object that needs to be added to the system

alert required	string Name of the alert
required	AlertType (string) Type of the alert
description	string Description of the alert
required	RuleType (string) Type of the rule
evalWindow	string Evaluation time window (ex - (now-15m, now)) for the alert in parseable format ("15m", "30m" "1h" etc.). Default is 5m.
frequency	string Run frequency of the alert in parseable format ("15m", "30m" "1h" etc.). Default is 1m.
required	object Condition criteria for the alert.
	object Labels kv map for the alert
	object Annotations kv map for the alert
disabled	boolean Whether the alert is disabled or not
source	string Source of the alert where it is created from.
preferredChannels	Array of strings Preferred channels for the alert. If not specified, all the channels will be used. Use the alert channel for this.

Responses

Request samples

Payload

Content type

application/json

{"alert": "string",
"alertType": "LOGS_BASED_ALERT",
"description": "string",
"ruleType": "threshold_rule",
"evalWindow": "string",
"frequency": "string",
"condition": {"target": null,
"matchType": "0",
"op": "0",
"compositeQuery": {"builderQueries": {"<queryName>": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
},
"chQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"promQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"panelType": "graph",
"queryType": "builder"
},
"targetUnit": "string",
"selectedQueryName": "string"
},
"labels": {"key": "string"
},
"annotations": {"key": "string"
},
"disabled": true,
"source": "string",
"preferredChannels": ["string"
]
}

Deletes a alert rule

path Parameters

required

integer <int64>

Alert rule id to delete

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Responses

dashboards

Access to dashboards

Add a dashboard to the system

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Request Body schema: application/json
required

Dashboard object that needs to be added to the system

title required	string Title of the dashboard
description	string Description of the dashboard
tags	Array of strings Tags for the dashboard
required	Array of objects Layout for the dashboard
	object Variables for the dashboard
required	Array of objects (Widget) Widgets for the dashboard

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"tags": ["string"
],
"layout": [{"x": 0,
"y": 0,
"w": 0,
"h": 0,
"i": "string",
"moved": true,
"static": true
}
],
"variables": {"key": {"id": "string",
"name": "string",
"description": "string",
"key": "string",
"type": "QUERY",
"queryValue": "string",
"allSelected": true,
"customValue": "string",
"multiSelect": true,
"order": 0,
"showALLOption": true,
"sort": "ASC",
"textboxValue": "string"
}
},
"widgets": [{"id": "string",
"description": "string",
"isStacked": true,
"nullZeroValues": true,
"opacity": 0,
"panelTypes": "graph",
"timePreferance": "GLOBAL_TIME",
"title": "string",
"yAxisUnit": "string",
"query": {"queryType": "builder",
"promql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"clickhouse_sql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"builder": {"queryData": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
},
"queryFormulas": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
}
}
}
]
}

Get all dashboards

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Responses

Response samples

Content type

application/json

{"title": "string",
"description": "string",
"tags": ["string"
],
"layout": [{"x": 0,
"y": 0,
"w": 0,
"h": 0,
"i": "string",
"moved": true,
"static": true
}
],
"variables": {"key": {"id": "string",
"name": "string",
"description": "string",
"key": "string",
"type": "QUERY",
"queryValue": "string",
"allSelected": true,
"customValue": "string",
"multiSelect": true,
"order": 0,
"showALLOption": true,
"sort": "ASC",
"textboxValue": "string"
}
},
"widgets": [{"id": "string",
"description": "string",
"isStacked": true,
"nullZeroValues": true,
"opacity": 0,
"panelTypes": "graph",
"timePreferance": "GLOBAL_TIME",
"title": "string",
"yAxisUnit": "string",
"query": {"queryType": "builder",
"promql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"clickhouse_sql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"builder": {"queryData": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
},
"queryFormulas": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
}
}
}
]
}

Find dashboard by UUID

Returns a single dashboard

path Parameters

required

string

ID of dashboard to return

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Responses

Response samples

Content type

application/json

{"title": "string",
"description": "string",
"tags": ["string"
],
"layout": [{"x": 0,
"y": 0,
"w": 0,
"h": 0,
"i": "string",
"moved": true,
"static": true
}
],
"variables": {"key": {"id": "string",
"name": "string",
"description": "string",
"key": "string",
"type": "QUERY",
"queryValue": "string",
"allSelected": true,
"customValue": "string",
"multiSelect": true,
"order": 0,
"showALLOption": true,
"sort": "ASC",
"textboxValue": "string"
}
},
"widgets": [{"id": "string",
"description": "string",
"isStacked": true,
"nullZeroValues": true,
"opacity": 0,
"panelTypes": "graph",
"timePreferance": "GLOBAL_TIME",
"title": "string",
"yAxisUnit": "string",
"query": {"queryType": "builder",
"promql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"clickhouse_sql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"builder": {"queryData": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
},
"queryFormulas": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
}
}
}
]
}

Update an existing dashboard

path Parameters

required

string

ID of dashboard to update

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Request Body schema: application/json
required

Dashboard object that needs to be added to the system

title required	string Title of the dashboard
description	string Description of the dashboard
tags	Array of strings Tags for the dashboard
required	Array of objects Layout for the dashboard
	object Variables for the dashboard
required	Array of objects (Widget) Widgets for the dashboard

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"tags": ["string"
],
"layout": [{"x": 0,
"y": 0,
"w": 0,
"h": 0,
"i": "string",
"moved": true,
"static": true
}
],
"variables": {"key": {"id": "string",
"name": "string",
"description": "string",
"key": "string",
"type": "QUERY",
"queryValue": "string",
"allSelected": true,
"customValue": "string",
"multiSelect": true,
"order": 0,
"showALLOption": true,
"sort": "ASC",
"textboxValue": "string"
}
},
"widgets": [{"id": "string",
"description": "string",
"isStacked": true,
"nullZeroValues": true,
"opacity": 0,
"panelTypes": "graph",
"timePreferance": "GLOBAL_TIME",
"title": "string",
"yAxisUnit": "string",
"query": {"queryType": "builder",
"promql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"clickhouse_sql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"builder": {"queryData": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
},
"queryFormulas": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
}
}
}
]
}

Deletes a alert rule

path Parameters

required

string

Alert rule id to delete

header Parameters

SIGNOZ-API-KEY

required

string

Example: <TOKEN>

Responses

The Alerts Model

alert required	string Name of the alert
required	AlertType (string) Type of the alert
description	string Description of the alert
required	RuleType (string) Type of the rule
evalWindow	string Evaluation time window (ex - (now-15m, now)) for the alert in parseable format ("15m", "30m" "1h" etc.). Default is 5m.
frequency	string Run frequency of the alert in parseable format ("15m", "30m" "1h" etc.). Default is 1m.
required	object Condition criteria for the alert.
	object Labels kv map for the alert
	object Annotations kv map for the alert
disabled	boolean Whether the alert is disabled or not
source	string Source of the alert where it is created from.
preferredChannels	Array of strings Preferred channels for the alert. If not specified, all the channels will be used. Use the alert channel for this.

{"alert": "string",
"alertType": "LOGS_BASED_ALERT",
"description": "string",
"ruleType": "threshold_rule",
"evalWindow": "string",
"frequency": "string",
"condition": {"target": null,
"matchType": "0",
"op": "0",
"compositeQuery": {"builderQueries": {"<queryName>": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
},
"chQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"promQueries": {"<queryName>": {"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
},
"panelType": "graph",
"queryType": "builder"
},
"targetUnit": "string",
"selectedQueryName": "string"
},
"labels": {"key": "string"
},
"annotations": {"key": "string"
},
"disabled": true,
"source": "string",
"preferredChannels": ["string"
]
}

The Dashboards Model

title required	string Title of the dashboard
description	string Description of the dashboard
tags	Array of strings Tags for the dashboard
required	Array of objects Layout for the dashboard
	object Variables for the dashboard
required	Array of objects (Widget) Widgets for the dashboard

{"title": "string",
"description": "string",
"tags": ["string"
],
"layout": [{"x": 0,
"y": 0,
"w": 0,
"h": 0,
"i": "string",
"moved": true,
"static": true
}
],
"variables": {"key": {"id": "string",
"name": "string",
"description": "string",
"key": "string",
"type": "QUERY",
"queryValue": "string",
"allSelected": true,
"customValue": "string",
"multiSelect": true,
"order": 0,
"showALLOption": true,
"sort": "ASC",
"textboxValue": "string"
}
},
"widgets": [{"id": "string",
"description": "string",
"isStacked": true,
"nullZeroValues": true,
"opacity": 0,
"panelTypes": "graph",
"timePreferance": "GLOBAL_TIME",
"title": "string",
"yAxisUnit": "string",
"query": {"queryType": "builder",
"promql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"clickhouse_sql": [{"disabled": true,
"name": "string",
"query": "string",
"legend": "string"
}
],
"builder": {"queryData": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
},
"queryFormulas": {"queryName": "string",
"stepInterval": null,
"dataSource": "metrics",
"aggregateOperator": "count",
"aggregateAttribute": {"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
},
"filters": {"op": "and",
"items": [{"key": {"key": null,
"type": null,
"dataType": null,
"isColumn": null,
"isJSON": null
},
"value": null,
"op": "="
}
]
},
"groupBy": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
],
"expression": "string",
"disabled": true,
"having": {"columnName": "string",
"op": "=",
"value": null
},
"legend": "string",
"limit": 0,
"offset": 0,
"pageSize": 0,
"orderBy": [{"columnName": "string",
"order": "asc"
}
],
"reduceTo": "sum",
"selectColumns": [{"key": "string",
"type": "tag",
"dataType": "string",
"isColumn": true,
"isJSON": true
}
]
}
}
}
}
]
}

Tesmon API (0.0.0)

Introduction

Authentication

api_key

alerts

Add a alert rule to the system

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Get all alert rules

header Parameters

Responses

Response samples

Find alert rule by ID

path Parameters

header Parameters

Responses

Response samples

Update an existing alert rule

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Deletes a alert rule

path Parameters

header Parameters

Responses

dashboards

Add a dashboard to the system

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Get all dashboards

header Parameters

Responses

Response samples

Find dashboard by UUID

path Parameters

header Parameters

Responses

Response samples

Update an existing dashboard

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Deletes a alert rule

path Parameters

header Parameters

Responses

The Alerts Model

The Dashboards Model

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required