Skip to main content
Validate a dashboard and return issues
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/dashboards/check/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dashboard": {
    "absoluteTimeFrame": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "fifteenMinutes": {},
    "layout": {
      "sections": [
        {
          "id": {
            "value": "<string>"
          },
          "options": {
            "custom": {
              "collapsed": false,
              "color": {},
              "description": "<string>",
              "name": "<string>",
              "repetitiveVar": {
                "name": "pod_name"
              }
            }
          },
          "rows": [
            {
              "appearance": {
                "height": 123
              },
              "id": {
                "value": "<string>"
              },
              "widgets": [
                {
                  "appearance": {
                    "width": 123
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "definition": {
                    "barChart": {
                      "colorScheme": "classic",
                      "colorsBy": {
                        "aggregation": {}
                      },
                      "customUnit": "mph",
                      "decimal": 4,
                      "decimalPrecision": false,
                      "groupNameTemplate": "Result - {{ variable }}",
                      "hashColors": false,
                      "legend": {
                        "columns": [
                          "LEGEND_COLUMN_MIN",
                          "LEGEND_COLUMN_MAX",
                          "LEGEND_COLUMN_NAME"
                        ],
                        "groupByQuery": true,
                        "isVisible": true
                      },
                      "maxBarsPerChart": 20,
                      "query": {
                        "dataprime": {
                          "dataprimeQuery": {
                            "text": "<string>"
                          },
                          "filters": [
                            {
                              "logs": {
                                "field": "<string>",
                                "observationField": {
                                  "keypath": [
                                    "<string>"
                                  ]
                                },
                                "operator": "<unknown>"
                              }
                            }
                          ],
                          "groupNames": [
                            "<string>"
                          ],
                          "stackedGroupName": "<string>",
                          "timeFrame": {
                            "absoluteTimeFrame": {
                              "from": "2023-11-07T05:31:56Z",
                              "to": "2023-11-07T05:31:56Z"
                            }
                          }
                        }
                      },
                      "stackDefinition": {
                        "maxSlicesPerBar": 123,
                        "stackNameTemplate": "<string>"
                      },
                      "xAxis": {
                        "time": {
                          "bucketsPresented": 123,
                          "interval": "<string>"
                        }
                      },
                      "yAxisMax": 1000,
                      "yAxisMin": -1000
                    }
                  },
                  "description": "<string>",
                  "id": {
                    "value": "<string>"
                  },
                  "layoutColumns": 1073741823,
                  "reference": {
                    "dashboardId": "<string>",
                    "widgetId": {
                      "value": "<string>"
                    }
                  },
                  "title": "<string>",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              ]
            }
          ]
        }
      ]
    },
    "name": "Example Name",
    "actions": [
      {
        "definition": {
          "customAction": {
            "url": "<string>"
          }
        },
        "id": "<string>",
        "name": "<string>",
        "queryId": "<string>",
        "shouldOpenInNewWindow": true,
        "widgetId": "<string>"
      }
    ],
    "annotations": [
      {
        "description": "<string>",
        "enabled": true,
        "id": "<string>",
        "name": "<string>",
        "scope": {
          "allWidgets": {}
        },
        "source": {
          "dataprime": {
            "labelFields": [
              {
                "keypath": [
                  "<string>"
                ]
              }
            ],
            "messageTemplate": "<string>",
            "query": {
              "text": "<string>"
            },
            "strategy": {
              "duration": {
                "durationField": {
                  "keypath": [
                    "<string>"
                  ]
                },
                "startTimestampField": {
                  "keypath": [
                    "<string>"
                  ]
                }
              }
            }
          }
        }
      }
    ],
    "description": "Sample description",
    "filters": [
      {
        "collapsed": true,
        "displayName": "<string>",
        "enabled": true,
        "id": {
          "value": "<string>"
        },
        "scope": {
          "allWidgets": {},
          "specificWidgets": {
            "widgetIds": [
              {
                "value": "<string>"
              }
            ]
          }
        },
        "source": {
          "logs": {
            "field": "<string>",
            "observationField": {
              "keypath": [
                "<string>"
              ]
            },
            "operator": {
              "equals": {
                "selection": {
                  "all": {}
                }
              }
            }
          }
        }
      }
    ],
    "folderId": {
      "value": "<string>"
    },
    "folderPath": {
      "segments": [
        "<string>"
      ]
    },
    "id": "GZLHSeqelCbD3I7HbIDtL",
    "slugName": "system-health-monitoring",
    "variables": [
      {
        "definition": {
          "constant": {
            "value": "<string>"
          }
        },
        "description": "<string>",
        "displayName": "<string>",
        "name": "<string>"
      }
    ],
    "variablesV2": [
      {
        "description": "<string>",
        "displayFullRow": true,
        "displayName": "<string>",
        "id": {
          "value": "<string>"
        },
        "name": "<string>",
        "source": {
          "query": {
            "dataprimeQuery": {
              "type": {
                "queryText": {
                  "query": {
                    "text": "<string>"
                  }
                }
              }
            },
            "allOption": {
              "includeAll": true,
              "label": "<string>"
            },
            "valueDisplayOptions": {
              "labelRegex": "<string>",
              "valueRegex": "<string>"
            }
          }
        },
        "value": {
          "interval": {
            "value": {
              "label": "<string>",
              "value": "<string>"
            }
          }
        }
      }
    ]
  },
  "requestId": "<string>"
}
'
{
  "issues": [
    {
      "location": "/sections/0/rows/1/widgets/2",
      "message": "Widget 'cpu-chart' references undefined variable 'env'",
      "severity": "SEVERITY_ERROR"
    },
    {
      "location": "/sections/1/rows/0/widgets/0/queries/0",
      "message": "Query uses deprecated function 'timeShift'",
      "severity": "SEVERITY_WARNING"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

Validate a dashboard definition or an existing dashboard by id

dashboard
Dashboard · object
required

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

requestId
string

Optional idempotency key for the check request

Required string length: 1 - 128
Pattern: ^[\s\S]*$

Response

Validation result containing a list of issues found in the dashboard

issues
object[]

List of validation issues; empty when the dashboard is valid

Maximum array length: 1000