Skip to main content
Get a dashboard by URL slug
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>"
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

slug
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