node
const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/dashboards/by-slug/%7Bslug%7D';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "dashboard": {
    "id": "GZLHSeqelCbD3I7HbIDtL",
    "name": "Example Name",
    "description": "Sample description",
    "layout": {
      "sections": [
        {
          "id": {
            "value": "<string>"
          },
          "rows": [
            {
              "id": {
                "value": "<string>"
              },
              "appearance": {
                "height": {
                  "value": 16
                }
              },
              "widgets": [
                {
                  "id": {
                    "value": "<string>"
                  },
                  "title": {
                    "value": "Gauge"
                  },
                  "description": {
                    "value": "Average delay of application"
                  },
                  "definition": {
                    "lineChart": {
                      "legend": "<any>",
                      "tooltip": "<any>",
                      "queryDefinitions": "<any>",
                      "stackedLine": "<any>"
                    },
                    "dataTable": {
                      "query": "<any>",
                      "resultsPerPage": "<any>",
                      "rowStyle": "<any>",
                      "columns": "<any>",
                      "orderBy": "<any>",
                      "dataModeType": "<any>"
                    },
                    "gauge": {
                      "query": "<any>",
                      "min": "<any>",
                      "max": "<any>",
                      "showInnerArc": "<any>",
                      "showOuterArc": "<any>",
                      "unit": "<any>",
                      "thresholds": "<any>",
                      "dataModeType": "<any>",
                      "thresholdBy": "<any>",
                      "customUnit": "<any>",
                      "decimal": "<any>",
                      "thresholdType": "<any>",
                      "legend": "<any>",
                      "legendBy": "<any>",
                      "displaySeriesName": "<any>",
                      "decimalPrecision": "<any>"
                    },
                    "pieChart": {
                      "query": "<any>",
                      "maxSlicesPerChart": "<any>",
                      "minSlicePercentage": "<any>",
                      "stackDefinition": "<any>",
                      "labelDefinition": "<any>",
                      "showLegend": "<any>",
                      "groupNameTemplate": "<any>",
                      "unit": "<any>",
                      "colorScheme": "<any>",
                      "dataModeType": "<any>",
                      "customUnit": "<any>",
                      "decimal": "<any>",
                      "legend": "<any>",
                      "hashColors": "<any>",
                      "decimalPrecision": "<any>"
                    },
                    "barChart": {
                      "query": "<any>",
                      "maxBarsPerChart": "<any>",
                      "groupNameTemplate": "<any>",
                      "stackDefinition": "<any>",
                      "scaleType": "<any>",
                      "colorsBy": "<any>",
                      "xAxis": "<any>",
                      "unit": "<any>",
                      "sortBy": "<any>",
                      "colorScheme": "<any>",
                      "dataModeType": "<any>",
                      "barValueDisplay": "<any>",
                      "customUnit": "<any>",
                      "decimal": "<any>",
                      "legend": "<any>",
                      "hashColors": "<any>",
                      "yAxisMin": "<any>",
                      "yAxisMax": "<any>",
                      "decimalPrecision": "<any>"
                    },
                    "horizontalBarChart": {
                      "query": "<any>",
                      "maxBarsPerChart": "<any>",
                      "groupNameTemplate": "<any>",
                      "stackDefinition": "<any>",
                      "scaleType": "<any>",
                      "colorsBy": "<any>",
                      "unit": "<any>",
                      "displayOnBar": "<any>",
                      "yAxisViewBy": "<any>",
                      "sortBy": "<any>",
                      "colorScheme": "<any>",
                      "dataModeType": "<any>",
                      "customUnit": "<any>",
                      "decimal": "<any>",
                      "legend": "<any>",
                      "hashColors": "<any>",
                      "yAxisMin": "<any>",
                      "yAxisMax": "<any>",
                      "decimalPrecision": "<any>"
                    },
                    "markdown": {
                      "markdownText": "<any>",
                      "tooltipText": "<any>"
                    },
                    "hexagon": {
                      "query": "<any>",
                      "min": "<any>",
                      "max": "<any>",
                      "unit": "<any>",
                      "thresholds": "<any>",
                      "dataModeType": "<any>",
                      "customUnit": "<any>",
                      "decimal": "<any>",
                      "thresholdType": "<any>",
                      "legend": "<any>",
                      "legendBy": "<any>",
                      "decimalPrecision": "<any>"
                    },
                    "dynamic": {
                      "query": "<any>",
                      "timeFrame": "<any>",
                      "interpretation": "<any>"
                    }
                  },
                  "appearance": {
                    "width": 123
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              ]
            }
          ],
          "options": {
            "internal": {},
            "custom": {
              "name": {
                "value": "Main stats section"
              },
              "description": {
                "value": "Section with important statistics"
              },
              "collapsed": false,
              "color": {
                "predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
              }
            }
          }
        }
      ]
    },
    "variables": [
      {
        "name": "<string>",
        "definition": {
          "constant": {
            "value": "<string>"
          },
          "multiSelect": {
            "selected": [
              "<string>"
            ],
            "source": {
              "logsPath": {
                "value": "<string>",
                "observationField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              },
              "metricLabel": {
                "metricName": "<string>",
                "label": "<string>"
              },
              "constantList": {
                "values": [
                  "<string>"
                ]
              },
              "spanField": {
                "value": {
                  "metadataField": "METADATA_FIELD_UNSPECIFIED",
                  "tagField": "<string>",
                  "processTagField": "<string>"
                }
              },
              "query": {
                "query": {
                  "logsQuery": {
                    "type": {
                      "fieldName": "<any>",
                      "fieldValue": "<any>"
                    }
                  },
                  "metricsQuery": {
                    "type": {
                      "metricName": "<any>",
                      "labelName": "<any>",
                      "labelValue": "<any>"
                    }
                  },
                  "spansQuery": {
                    "type": {
                      "fieldName": "<any>",
                      "fieldValue": "<any>"
                    }
                  }
                },
                "refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
                "valueDisplayOptions": {
                  "valueRegex": "<string>",
                  "labelRegex": "<string>"
                }
              }
            },
            "selection": {
              "all": {},
              "list": {
                "values": [
                  "<string>"
                ],
                "labels": [
                  "<string>"
                ]
              }
            },
            "valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
            "selectionOptions": {
              "selectionType": "SELECTION_TYPE_UNSPECIFIED"
            }
          }
        },
        "displayName": "<string>",
        "description": "<string>",
        "displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED"
      }
    ],
    "variablesV2": [
      {
        "name": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "displayType": "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED",
        "source": {
          "static": {
            "values": [
              {
                "value": "<string>",
                "label": "<string>",
                "isDefault": true
              }
            ],
            "valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
            "allOption": {
              "includeAll": true,
              "label": "<string>"
            }
          },
          "query": {
            "logsQuery": {
              "type": {
                "fieldName": {
                  "logRegex": "<string>"
                },
                "fieldValue": {
                  "observationField": {
                    "keypath": [
                      "<any>"
                    ],
                    "scope": "DATASET_SCOPE_UNSPECIFIED"
                  }
                }
              }
            },
            "metricsQuery": {
              "type": {
                "metricName": {
                  "metricRegex": "<string>"
                },
                "labelName": {
                  "metricRegex": "<string>"
                },
                "labelValue": {
                  "metricName": {
                    "stringValue": "<string>",
                    "variableName": "<string>"
                  },
                  "labelName": {
                    "stringValue": "<string>",
                    "variableName": "<string>"
                  },
                  "labelFilters": [
                    {
                      "metric": "<any>",
                      "label": "<any>",
                      "operator": "<any>"
                    }
                  ]
                }
              }
            },
            "spansQuery": {
              "type": {
                "fieldName": {
                  "spanRegex": "<string>"
                },
                "fieldValue": {
                  "value": {
                    "metadataField": "METADATA_FIELD_UNSPECIFIED",
                    "tagField": "<string>",
                    "processTagField": "<string>"
                  },
                  "observationField": {
                    "keypath": [
                      "<any>"
                    ],
                    "scope": "DATASET_SCOPE_UNSPECIFIED"
                  }
                }
              }
            },
            "valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
            "refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
            "valueDisplayOptions": {
              "valueRegex": "<string>",
              "labelRegex": "<string>"
            },
            "allOption": {
              "includeAll": true,
              "label": "<string>"
            }
          },
          "textbox": {
            "defaultValue": {
              "singleString": "<string>",
              "singleNumeric": 123
            }
          }
        },
        "value": {
          "multiString": {
            "all": {},
            "list": {
              "values": [
                {
                  "value": "<string>",
                  "label": "<string>"
                }
              ]
            }
          },
          "singleString": {
            "value": "<string>",
            "label": "<string>"
          },
          "singleNumeric": {
            "value": 123,
            "label": "<string>"
          },
          "regex": {
            "value": "<string>",
            "label": "<string>"
          },
          "lucene": {
            "value": "<string>",
            "label": "<string>"
          }
        },
        "displayFullRow": true
      }
    ],
    "filters": [
      {
        "source": {
          "logs": {
            "field": "<string>",
            "operator": {
              "equals": {
                "selection": {
                  "all": "<any>",
                  "list": "<any>"
                }
              },
              "notEquals": {
                "selection": {
                  "list": "<any>"
                }
              }
            },
            "observationField": {
              "keypath": [
                "<any>"
              ],
              "scope": "DATASET_SCOPE_UNSPECIFIED"
            }
          },
          "spans": {
            "field": {
              "metadataField": "METADATA_FIELD_UNSPECIFIED",
              "tagField": "<string>",
              "processTagField": "<string>"
            },
            "operator": {
              "equals": {
                "selection": {
                  "all": "<any>",
                  "list": "<any>"
                }
              },
              "notEquals": {
                "selection": {
                  "list": "<any>"
                }
              }
            },
            "observationField": {
              "keypath": [
                "<string>"
              ],
              "scope": "DATASET_SCOPE_UNSPECIFIED",
              "relationType": "SPAN_RELATION_TYPE_NONE_UNSPECIFIED"
            }
          },
          "metrics": {
            "metric": "<string>",
            "label": "<string>",
            "operator": {
              "equals": {
                "selection": {
                  "all": "<any>",
                  "list": "<any>"
                }
              },
              "notEquals": {
                "selection": {
                  "list": "<any>"
                }
              }
            }
          }
        },
        "enabled": true,
        "collapsed": true
      }
    ],
    "absoluteTimeFrame": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "relativeTimeFrame": "<string>",
    "folderId": {
      "value": "<string>"
    },
    "folderPath": {
      "segments": [
        "<string>"
      ]
    },
    "annotations": [
      {
        "id": "<string>",
        "name": "<string>",
        "enabled": true,
        "source": {
          "metrics": {
            "promqlQuery": {
              "value": "<string>"
            },
            "strategy": {
              "startTimeMetric": {}
            },
            "messageTemplate": "<string>",
            "labels": [
              "<string>"
            ]
          },
          "logs": {
            "luceneQuery": {
              "value": "<string>"
            },
            "strategy": {
              "instant": {
                "timestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              },
              "range": {
                "startTimestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                },
                "endTimestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              },
              "duration": {
                "startTimestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                },
                "durationField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              }
            },
            "messageTemplate": "<string>",
            "labelFields": [
              {
                "keypath": [
                  "<any>"
                ],
                "scope": "DATASET_SCOPE_UNSPECIFIED"
              }
            ]
          },
          "spans": {
            "luceneQuery": {
              "value": "<string>"
            },
            "strategy": {
              "instant": {
                "timestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              },
              "range": {
                "startTimestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                },
                "endTimestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              },
              "duration": {
                "startTimestampField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                },
                "durationField": {
                  "keypath": [
                    "<any>"
                  ],
                  "scope": "DATASET_SCOPE_UNSPECIFIED"
                }
              }
            },
            "messageTemplate": "<string>",
            "labelFields": [
              {
                "keypath": [
                  "<any>"
                ],
                "scope": "DATASET_SCOPE_UNSPECIFIED"
              }
            ]
          }
        }
      }
    ],
    "off": {},
    "twoMinutes": {},
    "fiveMinutes": {},
    "slugName": "system-health-monitoring",
    "actions": [
      {
        "id": "<string>",
        "name": "<string>",
        "shouldOpenInNewWindow": true,
        "widgetId": "<string>",
        "definition": {
          "customAction": {
            "url": "<string>"
          },
          "goToDashboardAction": {
            "dashboardId": "<string>"
          }
        },
        "dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED"
      }
    ]
  },
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updaterAuthorId": "<string>",
  "updaterName": "<string>",
  "authorId": "<string>",
  "authorName": "<string>",
  "updatedOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
  "createdOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
  "isLocked": true,
  "lockerAuthorId": "<string>",
  "lockerName": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

slug
string
required

Response

A successful response.

This is a response containing the requested dashboard

dashboard
object

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

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