Skip to main content
Get a dashboard
curl --request GET \
  --url https://api.coralogix.com/mgmt/openapi/4/dashboards/dashboards/v1/{dashboard_id} \
  --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": 123
              },
              "id": {
                "value": "<string>"
              },
              "widgets": [
                {
                  "appearance": {
                    "width": 123
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "definition": {
                    "hexagon": {
                      "customUnit": "<string>",
                      "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
                      "decimal": 2,
                      "decimalPrecision": false,
                      "legend": {
                        "columns": [
                          1,
                          2,
                          6
                        ],
                        "groupByQuery": true,
                        "isVisible": true,
                        "placement": "LEGEND_PLACEMENT_UNSPECIFIED"
                      },
                      "legendBy": "LEGEND_BY_UNSPECIFIED",
                      "max": 150000,
                      "min": 0,
                      "query": {
                        "spans": {
                          "filters": [
                            {
                              "field": {
                                "processTagField": "<string>"
                              },
                              "observationField": {
                                "keypath": [
                                  "<string>"
                                ],
                                "relationType": "SPAN_RELATION_TYPE_NONE_UNSPECIFIED",
                                "scope": "DATASET_SCOPE_UNSPECIFIED"
                              },
                              "operator": {
                                "equals": {
                                  "selection": {
                                    "all": {}
                                  }
                                }
                              }
                            }
                          ],
                          "groupBy": [
                            {
                              "processTagField": "<string>"
                            }
                          ],
                          "groupBys": [
                            {
                              "keypath": [
                                "<string>"
                              ],
                              "relationType": "SPAN_RELATION_TYPE_NONE_UNSPECIFIED",
                              "scope": "DATASET_SCOPE_UNSPECIFIED"
                            }
                          ],
                          "luceneQuery": {
                            "value": "<string>"
                          },
                          "spansAggregation": {
                            "metricAggregation": {
                              "aggregationType": "METRIC_AGGREGATION_TYPE_UNSPECIFIED",
                              "metricField": "METRIC_FIELD_UNSPECIFIED"
                            }
                          },
                          "timeFrame": {
                            "absoluteTimeFrame": {
                              "from": "2023-11-07T05:31:56Z",
                              "to": "2023-11-07T05:31:56Z"
                            }
                          }
                        }
                      },
                      "thresholdType": "THRESHOLD_TYPE_UNSPECIFIED",
                      "thresholds": [
                        {
                          "color": "<string>",
                          "from": 123,
                          "label": "<string>"
                        }
                      ],
                      "unit": "UNIT_UNSPECIFIED"
                    }
                  },
                  "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": [
      {
        "dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED",
        "definition": {
          "customAction": {
            "url": "<string>"
          }
        },
        "id": "<string>",
        "name": "<string>",
        "shouldOpenInNewWindow": true,
        "widgetId": "<string>"
      }
    ],
    "annotations": [
      {
        "color": "ANNOTATION_COLOR_UNSPECIFIED",
        "description": "<string>",
        "enabled": true,
        "id": "<string>",
        "name": "<string>",
        "scope": {
          "allWidgets": {}
        },
        "source": {
          "spans": {
            "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
            "labelFields": [
              {
                "keypath": [
                  "<string>"
                ],
                "scope": "DATASET_SCOPE_UNSPECIFIED"
              }
            ],
            "luceneQuery": {
              "value": "<string>"
            },
            "messageTemplate": "<string>",
            "strategy": {
              "instant": {
                "timestampField": {
                  "keypath": [
                    "<string>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              }
            }
          }
        }
      }
    ],
    "description": "Sample description",
    "filters": [
      {
        "collapsed": true,
        "displayName": "<string>",
        "enabled": true,
        "id": {
          "value": "<string>"
        },
        "source": {
          "logs": {
            "field": "<string>",
            "observationField": {
              "keypath": [
                "<string>"
              ],
              "scope": "DATASET_SCOPE_UNSPECIFIED"
            },
            "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>",
        "displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED",
        "name": "<string>"
      }
    ],
    "variablesV2": [
      {
        "description": "<string>",
        "displayFullRow": true,
        "displayName": "<string>",
        "displayType": "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED",
        "id": {
          "value": "<string>"
        },
        "name": "<string>",
        "source": {
          "static": {
            "allOption": {
              "includeAll": true,
              "label": "<string>"
            },
            "values": [
              {
                "isDefault": true,
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED"
          }
        },
        "value": {
          "multiString": {
            "all": {}
          }
        }
      }
    ]
  },
  "isLocked": true,
  "lockerAuthorId": "<string>",
  "lockerName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
  "updaterAuthorId": "<string>",
  "updaterName": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

dashboard_id
string
required

Response

This is a response containing the requested dashboard

authorId
string
authorName
string
createdAt
string<date-time>
createdOriginType
enum<string>
Available options:
TOKEN_ORIGIN_TYPE_UNSPECIFIED,
TOKEN_ORIGIN_TYPE_USER,
TOKEN_ORIGIN_TYPE_API
dashboard
Dashboard · object

Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.

isLocked
boolean
lockerAuthorId
string
lockerName
string
updatedAt
string<date-time>
updatedOriginType
enum<string>
Available options:
TOKEN_ORIGIN_TYPE_UNSPECIFIED,
TOKEN_ORIGIN_TYPE_USER,
TOKEN_ORIGIN_TYPE_API
updaterAuthorId
string
updaterName
string