Skip to main content
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));
{
  "authorId": "<string>",
  "authorName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdOriginType": "TOKEN_ORIGIN_TYPE_UNSPECIFIED",
  "dashboard": {
    "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": [
      {
        "enabled": true,
        "id": "<string>",
        "name": "<string>",
        "source": {
          "metrics": {
            "labels": [
              "<any>"
            ],
            "messageTemplate": "<string>",
            "promqlQuery": {
              "value": "<any>"
            },
            "strategy": {
              "startTimeMetric": "<any>"
            }
          }
        }
      }
    ],
    "description": "Sample description",
    "filters": [
      {
        "collapsed": true,
        "displayName": "<string>",
        "enabled": true,
        "source": {
          "logs": {
            "field": "<string>",
            "observationField": {
              "keypath": "<any>",
              "scope": "<any>"
            },
            "operator": {
              "equals": "<any>"
            }
          }
        }
      }
    ],
    "folderId": {
      "value": "<any>"
    },
    "id": "GZLHSeqelCbD3I7HbIDtL",
    "layout": {
      "sections": [
        {
          "id": {
            "value": "<any>"
          },
          "options": {
            "internal": {}
          },
          "rows": [
            {}
          ]
        }
      ]
    },
    "name": "Example Name",
    "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",
        "name": "<string>",
        "source": {
          "static": {
            "allOption": {
              "includeAll": "<any>",
              "label": "<any>"
            },
            "values": [
              "<any>"
            ],
            "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

​
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
object

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

  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • 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
⌘I