Skip to main content
Create a new dashboard
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/latest/v1/dashboards/dashboards \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": {},
                  "description": "<string>",
                  "id": {
                    "value": "<string>"
                  },
                  "title": "<string>",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              ]
            }
          ]
        }
      ]
    },
    "name": "Example Name",
    "actions": [
      {
        "dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED",
        "definition": {
          "goToDashboardAction": {
            "dashboardId": "<string>"
          }
        },
        "id": "<string>",
        "name": "<string>",
        "shouldOpenInNewWindow": true,
        "widgetId": "<string>"
      }
    ],
    "annotations": [
      {
        "color": "ANNOTATION_COLOR_UNSPECIFIED",
        "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,
        "id": {
          "value": "<string>"
        },
        "source": {
          "metrics": {
            "label": "<string>",
            "metric": "<string>",
            "operator": {
              "equals": {
                "selection": {
                  "all": {}
                }
              }
            }
          }
        }
      }
    ],
    "fiveMinutes": {},
    "folderId": {
      "value": "<string>"
    },
    "folderPath": {
      "segments": [
        "<string>"
      ]
    },
    "id": "GZLHSeqelCbD3I7HbIDtL",
    "relativeTimeFrame": "<string>",
    "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": {
          "interval": {
            "value": {
              "label": "<string>",
              "value": "<string>"
            }
          }
        }
      }
    ]
  },
  "requestId": "<string>",
  "isLocked": true
}
'
{
  "dashboardId": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

This is a request used to create a new custom dashboard

​
dashboard
Dashboard · object
required

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

​
requestId
string
required
​
isLocked
boolean

Response

This is a response received when a custom dashboard is successfully created

​
dashboardId
string