curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/latest/v1/dashboards/by-slug/{slug} \
--header 'Authorization: <api-key>'{
"authorId": "<string>",
"authorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
"dashboard": {
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"internal": {}
},
"rows": [
{
"appearance": {
"height": {
"value": 16
}
},
"id": {
"value": "<string>"
},
"widgets": [
{
"appearance": {
"width": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"definition": {
"lineChart": {
"queryDefinitions": [
{
"id": {
"value": "73c65643-91d5-dba2-35cd-baa49dc65331"
},
"query": {
"logs": {
"aggregations": [
{
"max": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
],
"filters": [
{
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
"<string>"
],
"groupBys": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"luceneQuery": {
"value": "<string>"
},
"timeFrame": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
}
}
}
},
"colorScheme": {
"value": "classic"
},
"customUnit": {
"value": "rpm"
},
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"decimal": 4,
"decimalPrecision": false,
"hashColors": false,
"isVisible": true,
"name": {
"value": "Query A"
},
"resolution": {
"bucketsPresented": 123,
"interval": "<string>"
},
"scaleType": "SCALE_TYPE_UNSPECIFIED",
"seriesCountLimit": {
"value": 50
},
"seriesNameTemplate": {
"value": "Trace of {{ application }}"
},
"unit": "UNIT_UNSPECIFIED",
"yAxisMax": 1000,
"yAxisMin": -1000
}
],
"connectNulls": false,
"legend": {
"columns": [
"LEGEND_COLUMN_UNSPECIFIED"
],
"groupByQuery": true,
"isVisible": true,
"placement": "LEGEND_PLACEMENT_UNSPECIFIED"
},
"stackedLine": "STACKED_LINE_UNSPECIFIED",
"tooltip": {
"showLabels": true,
"type": "TOOLTIP_TYPE_UNSPECIFIED"
}
}
},
"description": {
"value": "Average delay of application"
},
"id": {
"value": "<string>"
},
"title": {
"value": "Gauge"
},
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"actions": [
{
"dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED",
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"specificWidgets": {
"widgetIds": [
"<string>"
]
}
},
"source": {
"dataprime": {
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"labelFields": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"messageTemplate": "<string>",
"orientation": "ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED",
"query": {
"text": "<string>"
},
"strategy": {
"instant": {
"timestampField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
}
}
}
],
"description": "Sample description",
"filters": [
{
"collapsed": true,
"displayName": "<string>",
"enabled": true,
"source": {
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"fiveMinutes": {},
"folderId": {
"value": "<string>"
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"slugName": "system-health-monitoring",
"variables": [
{
"definition": {
"constant": {
"value": "<string>"
}
},
"description": "<string>",
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED",
"name": "<string>"
}
],
"variablesV2": [
{
"description": "<string>",
"displayFullRow": true,
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED",
"name": "<string>",
"source": {
"textbox": {
"defaultValue": {
"defaultRegexValue": {
"value": "<string>"
}
}
}
},
"value": {
"interval": {
"value": {
"label": "<string>",
"value": "<string>"
}
}
}
}
]
},
"isLocked": true,
"lockerAuthorId": "<string>",
"lockerName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
"updaterAuthorId": "<string>",
"updaterName": "<string>"
}No description available
curl --request GET \
--url https://api.coralogix.com/mgmt/openapi/latest/v1/dashboards/by-slug/{slug} \
--header 'Authorization: <api-key>'{
"authorId": "<string>",
"authorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
"dashboard": {
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"internal": {}
},
"rows": [
{
"appearance": {
"height": {
"value": 16
}
},
"id": {
"value": "<string>"
},
"widgets": [
{
"appearance": {
"width": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"definition": {
"lineChart": {
"queryDefinitions": [
{
"id": {
"value": "73c65643-91d5-dba2-35cd-baa49dc65331"
},
"query": {
"logs": {
"aggregations": [
{
"max": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
],
"filters": [
{
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
"<string>"
],
"groupBys": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"luceneQuery": {
"value": "<string>"
},
"timeFrame": {
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
}
}
}
},
"colorScheme": {
"value": "classic"
},
"customUnit": {
"value": "rpm"
},
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"decimal": 4,
"decimalPrecision": false,
"hashColors": false,
"isVisible": true,
"name": {
"value": "Query A"
},
"resolution": {
"bucketsPresented": 123,
"interval": "<string>"
},
"scaleType": "SCALE_TYPE_UNSPECIFIED",
"seriesCountLimit": {
"value": 50
},
"seriesNameTemplate": {
"value": "Trace of {{ application }}"
},
"unit": "UNIT_UNSPECIFIED",
"yAxisMax": 1000,
"yAxisMin": -1000
}
],
"connectNulls": false,
"legend": {
"columns": [
"LEGEND_COLUMN_UNSPECIFIED"
],
"groupByQuery": true,
"isVisible": true,
"placement": "LEGEND_PLACEMENT_UNSPECIFIED"
},
"stackedLine": "STACKED_LINE_UNSPECIFIED",
"tooltip": {
"showLabels": true,
"type": "TOOLTIP_TYPE_UNSPECIFIED"
}
}
},
"description": {
"value": "Average delay of application"
},
"id": {
"value": "<string>"
},
"title": {
"value": "Gauge"
},
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"absoluteTimeFrame": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"actions": [
{
"dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED",
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"specificWidgets": {
"widgetIds": [
"<string>"
]
}
},
"source": {
"dataprime": {
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"labelFields": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"messageTemplate": "<string>",
"orientation": "ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED",
"query": {
"text": "<string>"
},
"strategy": {
"instant": {
"timestampField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
}
}
}
],
"description": "Sample description",
"filters": [
{
"collapsed": true,
"displayName": "<string>",
"enabled": true,
"source": {
"logs": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"fiveMinutes": {},
"folderId": {
"value": "<string>"
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"slugName": "system-health-monitoring",
"variables": [
{
"definition": {
"constant": {
"value": "<string>"
}
},
"description": "<string>",
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED",
"name": "<string>"
}
],
"variablesV2": [
{
"description": "<string>",
"displayFullRow": true,
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED",
"name": "<string>",
"source": {
"textbox": {
"defaultValue": {
"defaultRegexValue": {
"value": "<string>"
}
}
}
},
"value": {
"interval": {
"value": {
"label": "<string>",
"value": "<string>"
}
}
}
}
]
},
"isLocked": true,
"lockerAuthorId": "<string>",
"lockerName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
"updaterAuthorId": "<string>",
"updaterName": "<string>"
}API key authentication
This is a response containing the requested dashboard
TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
LineChart represents the configuration of a line chart widget.
Show child attributes
Show child attributes
Unique id of the query definition
{
"value": "73c65643-91d5-dba2-35cd-baa49dc65331"
}Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
DATASET_SCOPE_UNSPECIFIED, DATASET_SCOPE_USER_DATA, DATASET_SCOPE_LABEL, DATASET_SCOPE_METADATA Show child attributes
The log field to which the filter is applied.
Show child attributes
DATASET_SCOPE_UNSPECIFIED, DATASET_SCOPE_USER_DATA, DATASET_SCOPE_LABEL, DATASET_SCOPE_METADATA This data structure defines the comparison operation for the filter.
Show child attributes
This data structure represents an equality comparison operation.
Show child attributes
This data structure defines the values for the equality comparison.
Show child attributes
This data structure indicates that all values are selected.
List of field names to group the query results
Show child attributes
DATASET_SCOPE_UNSPECIFIED, DATASET_SCOPE_USER_DATA, DATASET_SCOPE_LABEL, DATASET_SCOPE_METADATA Show child attributes
Applied color scheme for this query, one of the predefined values
{ "value": "classic" }Custom unit (requires to have unit field as 'custom' to take effect)
{ "value": "rpm" }DATA_MODE_TYPE_HIGH_UNSPECIFIED, DATA_MODE_TYPE_ARCHIVE Number indicating the decimal precision of the numeric values, within range 0-15
4
Whether to render numeric value without abbreviation
false
Whether to ignore color scheme and derive colors from algorithm
false
Is the query visible
true
Custom name of the query
{ "value": "Query A" }Show child attributes
How many buckets to present in the selected timeframe
Interval of value sampling, i.e. every 5 minutes, every 1 second and so on
SCALE_TYPE_UNSPECIFIED, SCALE_TYPE_LINEAR, SCALE_TYPE_LOGARITHMIC Max count of the series per query
{ "value": 50 }Custom template for the series name
{ "value": "Trace of {{ application }}" }UNIT_UNSPECIFIED, UNIT_MICROSECONDS, UNIT_MILLISECONDS, UNIT_SECONDS, UNIT_BYTES, UNIT_KBYTES, UNIT_MBYTES, UNIT_GBYTES, UNIT_BYTES_IEC, UNIT_KIBYTES, UNIT_MIBYTES, UNIT_GIBYTES, UNIT_EUR_CENTS, UNIT_EUR, UNIT_USD_CENTS, UNIT_USD, UNIT_NANOSECONDS, UNIT_CUSTOM, UNIT_PERCENT_ZERO_ONE, UNIT_PERCENT_ZERO_HUNDRED, UNIT_PERCENT Number indicating the upper band for y axis
1000
Number indicating the lower band for y axis
-1000
Whether the line should remain connected instead of producing scattered points when null values are present in between
false
Show child attributes
LEGEND_COLUMN_UNSPECIFIED, LEGEND_COLUMN_MIN, LEGEND_COLUMN_MAX, LEGEND_COLUMN_SUM, LEGEND_COLUMN_AVG, LEGEND_COLUMN_LAST, LEGEND_COLUMN_NAME, LEGEND_COLUMN_SIMPLE_VALUE In case of multiple queries, whether legend items should be grouped by their respective queries
Is the legend visible in the widget
LEGEND_PLACEMENT_UNSPECIFIED, LEGEND_PLACEMENT_AUTO, LEGEND_PLACEMENT_BOTTOM, LEGEND_PLACEMENT_SIDE, LEGEND_PLACEMENT_HIDDEN STACKED_LINE_UNSPECIFIED, STACKED_LINE_ABSOLUTE, STACKED_LINE_RELATIVE Short description of the widget
{ "value": "Average delay of application" }Name of the widget
{ "value": "Gauge" }The display name of the dashboard
"Example Name"
Show child attributes
ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED, ACTION_DATA_SOURCE_TYPE_LOGS, ACTION_DATA_SOURCE_TYPE_SPANS, ACTION_DATA_SOURCE_TYPE_METRICS, ACTION_DATA_SOURCE_TYPE_DATAPRIME A unique identifier of the action
The display name of the action
Defines if the action should open in a new window or current window in the browser
Reference to specific widget within a dashboard, can be null if the action is dashboard wide
Show child attributes
Show child attributes
Show child attributes
DATA_MODE_TYPE_HIGH_UNSPECIFIED, DATA_MODE_TYPE_ARCHIVE ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED, ANNOTATION_ORIENTATION_HORIZONTAL Show child attributes
Show child attributes
Show child attributes
A brief description or summary of the dashboard's purpose or content
"Sample description"
Show child attributes
Indicates if the filter's UI representation should be collapsed or expanded.
A display name for the filter
Indicates if the filter is currently enabled or not.
Defines the type of data the filter applies to.
Show child attributes
This data structure represents the filter criteria for logs.
Show child attributes
The log field to which the filter is applied.
This data structure defines the comparison operation for the filter.
Show child attributes
This data structure represents an equality comparison operation.
Show child attributes
This data structure defines the values for the equality comparison.
Show child attributes
This data structure indicates that all values are selected.
A unique identifier of the dashboard
"GZLHSeqelCbD3I7HbIDtL"
A unique slug name serving as an alias for accessing the dashboard
"system-health-monitoring"
Show child attributes
VARIABLE_DISPLAY_TYPE_UNSPECIFIED, VARIABLE_DISPLAY_TYPE_LABEL_VALUE, VARIABLE_DISPLAY_TYPE_VALUE, VARIABLE_DISPLAY_TYPE_NOTHING Show child attributes
VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED, VARIABLE_DISPLAY_TYPE_V2_LABEL_VALUE, VARIABLE_DISPLAY_TYPE_V2_VALUE, VARIABLE_DISPLAY_TYPE_V2_NOTHING Show child attributes
Show child attributes
TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API Was this page helpful?