Skip to main content
node
const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/dashboards/dashboards';

let options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
  body: '{"dashboard":{"absoluteTimeFrame":{"from":"2019-08-24T14:15:22Z","to":"2019-08-24T14:15:22Z"},"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":{"logs":{"dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","labelFields":[{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}],"luceneQuery":{"value":"string"},"messageTemplate":"string","strategy":{"instant":{"timestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}}}}}}],"description":"Sample description","filters":[{"collapsed":true,"displayName":"string","enabled":true,"source":{"spans":{"field":{"tagField":"string"},"observationField":{"keypath":["string"],"relationType":"SPAN_RELATION_TYPE_NONE_UNSPECIFIED","scope":"DATASET_SCOPE_UNSPECIFIED"},"operator":{"equals":{"selection":{"all":{}}}}}}}],"fiveMinutes":{},"folderId":{"value":"string"},"id":"GZLHSeqelCbD3I7HbIDtL","layout":{"sections":[{"id":{"value":"string"},"options":{"custom":{"collapsed":false,"color":{"predefined":"SECTION_PREDEFINED_COLOR_UNSPECIFIED"},"description":{"value":"Section with important statistics"},"name":{"value":"Main stats section"},"repetitiveVar":{"name":"pod_name"}}},"rows":[{"appearance":{"height":{"value":16}},"id":{"value":"string"},"widgets":[{"appearance":{"width":0},"createdAt":"2019-08-24T14:15:22Z","definition":{"barChart":{"barValueDisplay":"BAR_VALUE_DISPLAY_UNSPECIFIED","colorScheme":"classic","colorsBy":{"aggregation":{}},"customUnit":"mph","dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","decimal":4,"decimalPrecision":false,"groupNameTemplate":"Result - {{ variable }}","hashColors":false,"legend":{"columns":["LEGEND_COLUMN_UNSPECIFIED"],"groupByQuery":true,"isVisible":true,"placement":"LEGEND_PLACEMENT_UNSPECIFIED"},"maxBarsPerChart":20,"query":{"logs":{"aggregation":{"min":{}},"filters":[{}],"groupNames":["string"],"groupNamesFields":[{"keypath":[]}],"luceneQuery":{"value":"string"},"stackedGroupName":"string","stackedGroupNameField":{"keypath":[null],"scope":"DATASET_SCOPE_UNSPECIFIED"},"timeFrame":{"absoluteTimeFrame":{}}}},"scaleType":"SCALE_TYPE_UNSPECIFIED","sortBy":"SORT_BY_TYPE_UNSPECIFIED","stackDefinition":{"maxSlicesPerBar":0,"stackNameTemplate":"string"},"unit":"UNIT_UNSPECIFIED","xAxis":{"value":{}},"yAxisMax":1000,"yAxisMin":-1000}},"description":{"value":"Average delay of application"},"id":{"value":"string"},"title":{"value":"Gauge"},"updatedAt":"2019-08-24T14:15:22Z"}]}]}]},"name":"Example Name","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":{"defaultNumericValue":{"isInteger":true,"max":0.1,"min":0.1,"value":0.1}}}},"value":{"multiString":{"all":{}}}}]},"isLocked":true,"requestId":"string"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

This is a request sent to update an existing dashboard with new information

​
dashboard
object
required

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

  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
​
requestId
string
required
​
isLocked
boolean

Response

This is a response received when the dashboard is successfully updated