curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/5/dashboards/dashboards/v1/{dashboard_id} \
--header 'Authorization: <api-key>'{
"accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}",
"authorId": "<string>",
"authorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dashboard": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"fifteenMinutes": {},
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"custom": {
"collapsed": false,
"color": {},
"description": "<string>",
"name": "<string>",
"repetitiveVar": {
"name": "pod_name"
}
}
},
"rows": [
{
"appearance": {
"height": 123
},
"id": {
"value": "<string>"
},
"widgets": [
{
"appearance": {
"width": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"definition": {
"barChart": {
"colorScheme": "classic",
"colorsBy": {
"aggregation": {}
},
"customUnit": "mph",
"decimal": 4,
"decimalPrecision": false,
"groupNameTemplate": "Result - {{ variable }}",
"hashColors": false,
"legend": {
"columns": [
"LEGEND_COLUMN_MIN",
"LEGEND_COLUMN_MAX",
"LEGEND_COLUMN_NAME"
],
"groupByQuery": true,
"isVisible": true
},
"maxBarsPerChart": 20,
"query": {
"dataprime": {
"dataprimeQuery": {
"text": "<string>"
},
"filters": [
{
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
]
},
"operator": "<unknown>"
}
}
],
"groupNames": [
"<string>"
],
"stackedGroupName": "<string>",
"timeFrame": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
}
}
}
},
"stackDefinition": {
"maxSlicesPerBar": 123,
"stackNameTemplate": "<string>"
},
"xAxis": {
"time": {
"bucketsPresented": 123,
"interval": "<string>"
}
},
"yAxisMax": 1000,
"yAxisMin": -1000
}
},
"description": "<string>",
"id": {
"value": "<string>"
},
"reference": {
"dashboardId": "<string>",
"widgetId": {
"value": "<string>"
}
},
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"actions": [
{
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"queryId": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"allWidgets": {}
},
"source": {
"dataprime": {
"labelFields": [
{
"keypath": [
"<string>"
]
}
],
"messageTemplate": "<string>",
"query": {
"text": "<string>"
},
"strategy": {
"duration": {
"durationField": {
"keypath": [
"<string>"
]
},
"startTimestampField": {
"keypath": [
"<string>"
]
}
}
}
}
}
}
],
"description": "Sample description",
"filters": [
{
"collapsed": true,
"displayName": "<string>",
"enabled": true,
"id": {
"value": "<string>"
},
"scope": {
"allWidgets": {},
"specificWidgets": {
"widgetIds": [
{
"value": "<string>"
}
]
}
},
"source": {
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
]
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"folderId": {
"value": "<string>"
},
"folderPath": {
"segments": [
"<string>"
]
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"slugName": "system-health-monitoring",
"variables": [
{
"definition": {
"constant": {
"value": "<string>"
}
},
"description": "<string>",
"displayName": "<string>",
"name": "<string>"
}
],
"variablesV2": [
{
"description": "<string>",
"displayFullRow": true,
"displayName": "<string>",
"id": {
"value": "<string>"
},
"name": "<string>",
"source": {
"query": {
"dataprimeQuery": {
"type": {
"queryText": {
"query": {
"text": "<string>"
}
}
}
},
"allOption": {
"includeAll": true,
"label": "<string>"
},
"valueDisplayOptions": {
"labelRegex": "<string>",
"valueRegex": "<string>"
}
}
},
"value": {
"interval": {
"value": {
"label": "<string>",
"value": "<string>"
}
}
}
}
]
},
"isLocked": true,
"lockerAuthorId": "<string>",
"lockerName": "<string>",
"resolvedWidgets": {},
"updatedAt": "2023-11-07T05:31:56Z",
"updaterAuthorId": "<string>",
"updaterName": "<string>"
}Get a dashboard
Returns the details of the specified dashboard.
Requires the following permissions:
team-dashboards:Read
curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/5/dashboards/dashboards/v1/{dashboard_id} \
--header 'Authorization: <api-key>'{
"accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}",
"authorId": "<string>",
"authorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dashboard": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"fifteenMinutes": {},
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"custom": {
"collapsed": false,
"color": {},
"description": "<string>",
"name": "<string>",
"repetitiveVar": {
"name": "pod_name"
}
}
},
"rows": [
{
"appearance": {
"height": 123
},
"id": {
"value": "<string>"
},
"widgets": [
{
"appearance": {
"width": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"definition": {
"barChart": {
"colorScheme": "classic",
"colorsBy": {
"aggregation": {}
},
"customUnit": "mph",
"decimal": 4,
"decimalPrecision": false,
"groupNameTemplate": "Result - {{ variable }}",
"hashColors": false,
"legend": {
"columns": [
"LEGEND_COLUMN_MIN",
"LEGEND_COLUMN_MAX",
"LEGEND_COLUMN_NAME"
],
"groupByQuery": true,
"isVisible": true
},
"maxBarsPerChart": 20,
"query": {
"dataprime": {
"dataprimeQuery": {
"text": "<string>"
},
"filters": [
{
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
]
},
"operator": "<unknown>"
}
}
],
"groupNames": [
"<string>"
],
"stackedGroupName": "<string>",
"timeFrame": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
}
}
}
},
"stackDefinition": {
"maxSlicesPerBar": 123,
"stackNameTemplate": "<string>"
},
"xAxis": {
"time": {
"bucketsPresented": 123,
"interval": "<string>"
}
},
"yAxisMax": 1000,
"yAxisMin": -1000
}
},
"description": "<string>",
"id": {
"value": "<string>"
},
"reference": {
"dashboardId": "<string>",
"widgetId": {
"value": "<string>"
}
},
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"actions": [
{
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"queryId": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"allWidgets": {}
},
"source": {
"dataprime": {
"labelFields": [
{
"keypath": [
"<string>"
]
}
],
"messageTemplate": "<string>",
"query": {
"text": "<string>"
},
"strategy": {
"duration": {
"durationField": {
"keypath": [
"<string>"
]
},
"startTimestampField": {
"keypath": [
"<string>"
]
}
}
}
}
}
}
],
"description": "Sample description",
"filters": [
{
"collapsed": true,
"displayName": "<string>",
"enabled": true,
"id": {
"value": "<string>"
},
"scope": {
"allWidgets": {},
"specificWidgets": {
"widgetIds": [
{
"value": "<string>"
}
]
}
},
"source": {
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
]
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"folderId": {
"value": "<string>"
},
"folderPath": {
"segments": [
"<string>"
]
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"slugName": "system-health-monitoring",
"variables": [
{
"definition": {
"constant": {
"value": "<string>"
}
},
"description": "<string>",
"displayName": "<string>",
"name": "<string>"
}
],
"variablesV2": [
{
"description": "<string>",
"displayFullRow": true,
"displayName": "<string>",
"id": {
"value": "<string>"
},
"name": "<string>",
"source": {
"query": {
"dataprimeQuery": {
"type": {
"queryText": {
"query": {
"text": "<string>"
}
}
}
},
"allOption": {
"includeAll": true,
"label": "<string>"
},
"valueDisplayOptions": {
"labelRegex": "<string>",
"valueRegex": "<string>"
}
}
},
"value": {
"interval": {
"value": {
"label": "<string>",
"value": "<string>"
}
}
}
}
]
},
"isLocked": true,
"lockerAuthorId": "<string>",
"lockerName": "<string>",
"resolvedWidgets": {},
"updatedAt": "2023-11-07T05:31:56Z",
"updaterAuthorId": "<string>",
"updaterName": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key authentication
Path Parameters
The dashboard id.
Response
This is a response containing the requested dashboard
JSON string representing the access policy for this dashboard. Defines granular permissions for users and groups.
1 - 65536^[\s\S]*$"{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}"
The author id.
The author name.
Creation timestamp.
Token origin type.
TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.
- Dashboard
- Dashboard
- Dashboard
- Dashboard
- Dashboard
- Dashboard
- Dashboard
- Dashboard
- Dashboard
- Dashboard
Show child attributes
Show child attributes
The is locked.
The locker author id.
The locker name.
Map of resolved widget references for widgets with references in the dashboard
Show child attributes
Show child attributes
Last-updated timestamp.
Token origin type.
TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API The updater author id.
The updater name.
Was this page helpful?