Get a dashboard by URL slug
curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/4/dashboards/dashboards/v1/slugs/{slug} \
--header 'Authorization: <api-key>'{
"authorId": "<string>",
"authorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dashboard": {
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"internal": {}
},
"rows": [
{
"appearance": {
"height": 123
},
"id": {
"value": "<string>"
},
"widgets": [
{
"appearance": {
"width": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"definition": {
"hexagon": {
"customUnit": "<string>",
"decimal": 2,
"decimalPrecision": false,
"legend": {
"columns": [
1,
2,
6
],
"groupByQuery": true,
"isVisible": true
},
"max": 150000,
"min": 0,
"query": {
"spans": {
"filters": [
{
"field": {
"processTagField": "<string>"
},
"observationField": {
"keypath": [
"<string>"
]
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
{
"processTagField": "<string>"
}
],
"groupBys": [
{
"keypath": [
"<string>"
]
}
],
"luceneQuery": {
"value": "<string>"
},
"spansAggregation": {
"metricAggregation": {}
},
"timeFrame": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
}
}
}
},
"thresholds": [
{
"color": "<string>",
"from": 123,
"label": "<string>"
}
]
}
},
"description": "<string>",
"id": {
"value": "<string>"
},
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"actions": [
{
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"allWidgets": {}
},
"source": {
"spans": {
"labelFields": [
{
"keypath": [
"<string>"
]
}
],
"luceneQuery": {
"value": "<string>"
},
"messageTemplate": "<string>",
"strategy": {
"instant": {
"timestampField": {
"keypath": [
"<string>"
]
}
}
}
}
}
}
],
"description": "Sample description",
"filters": [
{
"collapsed": true,
"displayName": "<string>",
"enabled": true,
"id": {
"value": "<string>"
},
"source": {
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
]
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"folderId": {
"value": "<string>"
},
"folderPath": {
"segments": [
"<string>"
]
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"off": {},
"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": {
"static": {
"allOption": {
"includeAll": true,
"label": "<string>"
},
"values": [
{
"isDefault": true,
"label": "<string>",
"value": "<string>"
}
]
}
},
"value": {
"multiString": {
"all": {}
}
}
}
]
},
"isLocked": true,
"lockerAuthorId": "<string>",
"lockerName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updaterAuthorId": "<string>",
"updaterName": "<string>"
}Dashboard Service
Get a dashboard by URL slug
No description available
Get a dashboard by URL slug
curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/4/dashboards/dashboards/v1/slugs/{slug} \
--header 'Authorization: <api-key>'{
"authorId": "<string>",
"authorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"dashboard": {
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"internal": {}
},
"rows": [
{
"appearance": {
"height": 123
},
"id": {
"value": "<string>"
},
"widgets": [
{
"appearance": {
"width": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"definition": {
"hexagon": {
"customUnit": "<string>",
"decimal": 2,
"decimalPrecision": false,
"legend": {
"columns": [
1,
2,
6
],
"groupByQuery": true,
"isVisible": true
},
"max": 150000,
"min": 0,
"query": {
"spans": {
"filters": [
{
"field": {
"processTagField": "<string>"
},
"observationField": {
"keypath": [
"<string>"
]
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
{
"processTagField": "<string>"
}
],
"groupBys": [
{
"keypath": [
"<string>"
]
}
],
"luceneQuery": {
"value": "<string>"
},
"spansAggregation": {
"metricAggregation": {}
},
"timeFrame": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
}
}
}
},
"thresholds": [
{
"color": "<string>",
"from": 123,
"label": "<string>"
}
]
}
},
"description": "<string>",
"id": {
"value": "<string>"
},
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"actions": [
{
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"allWidgets": {}
},
"source": {
"spans": {
"labelFields": [
{
"keypath": [
"<string>"
]
}
],
"luceneQuery": {
"value": "<string>"
},
"messageTemplate": "<string>",
"strategy": {
"instant": {
"timestampField": {
"keypath": [
"<string>"
]
}
}
}
}
}
}
],
"description": "Sample description",
"filters": [
{
"collapsed": true,
"displayName": "<string>",
"enabled": true,
"id": {
"value": "<string>"
},
"source": {
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
]
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"folderId": {
"value": "<string>"
},
"folderPath": {
"segments": [
"<string>"
]
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"off": {},
"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": {
"static": {
"allOption": {
"includeAll": true,
"label": "<string>"
},
"values": [
{
"isDefault": true,
"label": "<string>",
"value": "<string>"
}
]
}
},
"value": {
"multiString": {
"all": {}
}
}
}
]
},
"isLocked": true,
"lockerAuthorId": "<string>",
"lockerName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updaterAuthorId": "<string>",
"updaterName": "<string>"
}Authorizations
API key authentication
Path Parameters
Response
This is a response containing the requested dashboard
Available options:
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
Show child attributes
Show child attributes
Available options:
TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API Was this page helpful?
⌘I