POST
/
v1
/
dashboards
/
dashboards
const fetch = require('node-fetch');

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

let options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
  body: '{"requestId":"string","dashboard":{"id":"string","name":"string","description":"string","layout":{"sections":[{"id":{"value":"string"},"rows":[{"id":{"value":"string"},"appearance":{"height":0},"widgets":[{"id":{"value":"string"},"title":"string","description":"string","definition":{"lineChart":{"legend":{"isVisible":true,"columns":["LEGEND_COLUMN_UNSPECIFIED"],"groupByQuery":true,"placement":"LEGEND_PLACEMENT_UNSPECIFIED"},"tooltip":{"showLabels":true,"type":"TOOLTIP_TYPE_UNSPECIFIED"},"queryDefinitions":[{"id":"string","query":{"logs":{"groupBy":[],"aggregations":[],"filters":[],"groupBys":[]},"metrics":{"filters":[]},"spans":{"groupBy":[],"aggregations":[],"filters":[],"groupBys":[]},"dataprime":{"filters":[]}},"seriesNameTemplate":"string","seriesCountLimit":"string","unit":"UNIT_UNSPECIFIED","scaleType":"SCALE_TYPE_UNSPECIFIED","name":"string","isVisible":true,"colorScheme":"string","resolution":{"interval":"string","bucketsPresented":0},"dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","customUnit":"string","decimal":0,"customLinks":[{}]}],"stackedLine":"STACKED_LINE_UNSPECIFIED"},"dataTable":{"query":{"logs":{"luceneQuery":{"value":"string"},"filters":[{}],"grouping":{"groupBy":[null],"aggregations":[null],"groupBys":[null]},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}},"spans":{"luceneQuery":{"value":"string"},"filters":[{}],"grouping":{"groupBy":[null],"aggregations":[null],"groupBys":[null]},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}},"metrics":{"promqlQuery":{"value":"string"},"filters":[{}],"editorMode":"METRICS_QUERY_EDITOR_MODE_UNSPECIFIED","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"promqlQueryType":"PROM_QL_QUERY_TYPE_UNSPECIFIED"},"dataprime":{"dataprimeQuery":{"text":"string"},"filters":[{}],"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}}},"resultsPerPage":0,"rowStyle":"ROW_STYLE_UNSPECIFIED","columns":[{"field":"string","width":0}],"orderBy":{"field":"string","orderDirection":"ORDER_DIRECTION_UNSPECIFIED"},"customLinks":[{"id":{"value":"string"},"linkName":"string","openInNewWindow":true,"isPrivate":true,"createdBy":"string","custom":{"url":"string"},"template":{"url":"string","type":"CUSTOM_LINK_TEMPLATE_TYPE_UNSPECIFIED"}}],"dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED"},"gauge":{"query":{"metrics":{"promqlQuery":{"value":"string"},"aggregation":"AGGREGATION_UNSPECIFIED","filters":[{}],"editorMode":"METRICS_QUERY_EDITOR_MODE_UNSPECIFIED","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"promqlQueryType":"PROM_QL_QUERY_TYPE_UNSPECIFIED"},"logs":{"luceneQuery":{"value":"string"},"logsAggregation":{"count":{},"countDistinct":{},"sum":{},"average":{},"min":{},"max":{},"percentile":{}},"aggregation":"AGGREGATION_UNSPECIFIED","filters":[{}],"groupBy":[{"keypath":[]}],"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}},"spans":{"luceneQuery":{"value":"string"},"spansAggregation":{"metricAggregation":{},"dimensionAggregation":{}},"aggregation":"AGGREGATION_UNSPECIFIED","filters":[{}],"groupBy":[{}],"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"groupBys":[{"keypath":[]}]},"dataprime":{"dataprimeQuery":{"text":"string"},"filters":[{}],"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}}},"min":0.1,"max":0.1,"showInnerArc":true,"showOuterArc":true,"unit":"UNIT_UNSPECIFIED","thresholds":[{"from":0.1,"color":"string","label":"string"}],"dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","thresholdBy":"THRESHOLD_BY_UNSPECIFIED","customUnit":"string","decimal":0,"thresholdType":"THRESHOLD_TYPE_UNSPECIFIED","legend":{"isVisible":true,"columns":["LEGEND_COLUMN_UNSPECIFIED"],"groupByQuery":true,"placement":"LEGEND_PLACEMENT_UNSPECIFIED"},"legendBy":"LEGEND_BY_UNSPECIFIED","displaySeriesName":true,"customLinks":[{"id":{"value":"string"},"linkName":"string","openInNewWindow":true,"isPrivate":true,"createdBy":"string","custom":{"url":"string"},"template":{"url":"string","type":"CUSTOM_LINK_TEMPLATE_TYPE_UNSPECIFIED"}}]},"pieChart":{"query":{"logs":{"luceneQuery":{"value":"string"},"aggregation":{"count":{},"countDistinct":{},"sum":{},"average":{},"min":{},"max":{},"percentile":{}},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","groupNamesFields":[{"keypath":[]}],"stackedGroupNameField":{"keypath":[null],"scope":"DATASET_SCOPE_UNSPECIFIED"},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}},"spans":{"luceneQuery":{"value":"string"},"aggregation":{"metricAggregation":{},"dimensionAggregation":{}},"filters":[{}],"groupNames":[{}],"stackedGroupName":{"metadataField":"METADATA_FIELD_UNSPECIFIED","tagField":"string","processTagField":"string"},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"groupNamesFields":[{"keypath":[]}],"stackedGroupNameField":{"keypath":[null],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"metrics":{"promqlQuery":{"value":"string"},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","editorMode":"METRICS_QUERY_EDITOR_MODE_UNSPECIFIED","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"promqlQueryType":"PROM_QL_QUERY_TYPE_UNSPECIFIED","aggregation":"AGGREGATION_UNSPECIFIED"},"dataprime":{"dataprimeQuery":{"text":"string"},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}}},"maxSlicesPerChart":0,"minSlicePercentage":0,"stackDefinition":{"maxSlicesPerStack":0,"stackNameTemplate":"string"},"labelDefinition":{"labelSource":"LABEL_SOURCE_UNSPECIFIED","isVisible":true,"showName":true,"showValue":true,"showPercentage":true},"showLegend":true,"groupNameTemplate":"string","unit":"UNIT_UNSPECIFIED","colorScheme":"string","dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","customUnit":"string","decimal":0,"legend":{"isVisible":true,"columns":["LEGEND_COLUMN_UNSPECIFIED"],"groupByQuery":true,"placement":"LEGEND_PLACEMENT_UNSPECIFIED"},"customLinks":[{"id":{"value":"string"},"linkName":"string","openInNewWindow":true,"isPrivate":true,"createdBy":"string","custom":{"url":"string"},"template":{"url":"string","type":"CUSTOM_LINK_TEMPLATE_TYPE_UNSPECIFIED"}}]},"barChart":{"query":{"logs":{"luceneQuery":{"value":"string"},"aggregation":{"count":{},"countDistinct":{},"sum":{},"average":{},"min":{},"max":{},"percentile":{}},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","groupNamesFields":[{"keypath":[]}],"stackedGroupNameField":{"keypath":[null],"scope":"DATASET_SCOPE_UNSPECIFIED"},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}},"spans":{"luceneQuery":{"value":"string"},"aggregation":{"metricAggregation":{},"dimensionAggregation":{}},"filters":[{}],"groupNames":[{}],"stackedGroupName":{"metadataField":"METADATA_FIELD_UNSPECIFIED","tagField":"string","processTagField":"string"},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"groupNamesFields":[{"keypath":[]}],"stackedGroupNameField":{"keypath":[null],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"metrics":{"promqlQuery":{"value":"string"},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","editorMode":"METRICS_QUERY_EDITOR_MODE_UNSPECIFIED","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"promqlQueryType":"PROM_QL_QUERY_TYPE_UNSPECIFIED","aggregation":"AGGREGATION_UNSPECIFIED"},"dataprime":{"dataprimeQuery":{"text":"string"},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}}},"maxBarsPerChart":0,"groupNameTemplate":"string","stackDefinition":{"maxSlicesPerBar":0,"stackNameTemplate":"string"},"scaleType":"SCALE_TYPE_UNSPECIFIED","colorsBy":{"stack":{},"groupBy":{},"aggregation":{}},"xAxis":{"value":{},"time":{"interval":"string","bucketsPresented":0}},"unit":"UNIT_UNSPECIFIED","sortBy":"SORT_BY_TYPE_UNSPECIFIED","colorScheme":"string","dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","barValueDisplay":"BAR_VALUE_DISPLAY_UNSPECIFIED","customUnit":"string","decimal":0,"legend":{"isVisible":true,"columns":["LEGEND_COLUMN_UNSPECIFIED"],"groupByQuery":true,"placement":"LEGEND_PLACEMENT_UNSPECIFIED"},"customLinks":[{"id":{"value":"string"},"linkName":"string","openInNewWindow":true,"isPrivate":true,"createdBy":"string","custom":{"url":"string"},"template":{"url":"string","type":"CUSTOM_LINK_TEMPLATE_TYPE_UNSPECIFIED"}}]},"horizontalBarChart":{"query":{"logs":{"luceneQuery":{"value":"string"},"aggregation":{"count":{},"countDistinct":{},"sum":{},"average":{},"min":{},"max":{},"percentile":{}},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","groupNamesFields":[{"keypath":[]}],"stackedGroupNameField":{"keypath":[null],"scope":"DATASET_SCOPE_UNSPECIFIED"},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}},"spans":{"luceneQuery":{"value":"string"},"aggregation":{"metricAggregation":{},"dimensionAggregation":{}},"filters":[{}],"groupNames":[{}],"stackedGroupName":{"metadataField":"METADATA_FIELD_UNSPECIFIED","tagField":"string","processTagField":"string"},"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"groupNamesFields":[{"keypath":[]}],"stackedGroupNameField":{"keypath":[null],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"metrics":{"promqlQuery":{"value":"string"},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","editorMode":"METRICS_QUERY_EDITOR_MODE_UNSPECIFIED","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"promqlQueryType":"PROM_QL_QUERY_TYPE_UNSPECIFIED","aggregation":"AGGREGATION_UNSPECIFIED"},"dataprime":{"dataprimeQuery":{"text":"string"},"filters":[{}],"groupNames":["string"],"stackedGroupName":"string","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}}},"maxBarsPerChart":0,"groupNameTemplate":"string","stackDefinition":{"maxSlicesPerBar":0,"stackNameTemplate":"string"},"scaleType":"SCALE_TYPE_UNSPECIFIED","colorsBy":{"stack":{},"groupBy":{},"aggregation":{}},"unit":"UNIT_UNSPECIFIED","displayOnBar":true,"yAxisViewBy":{"category":{},"value":{}},"sortBy":"SORT_BY_TYPE_UNSPECIFIED","colorScheme":"string","dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","customUnit":"string","decimal":0,"legend":{"isVisible":true,"columns":["LEGEND_COLUMN_UNSPECIFIED"],"groupByQuery":true,"placement":"LEGEND_PLACEMENT_UNSPECIFIED"},"customLinks":[{"id":{"value":"string"},"linkName":"string","openInNewWindow":true,"isPrivate":true,"createdBy":"string","custom":{"url":"string"},"template":{"url":"string","type":"CUSTOM_LINK_TEMPLATE_TYPE_UNSPECIFIED"}}]},"markdown":{"markdownText":"string","tooltipText":"string"},"hexagon":{"query":{"metrics":{"promqlQuery":{"value":"string"},"filters":[{}],"editorMode":"METRICS_QUERY_EDITOR_MODE_UNSPECIFIED","timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"aggregation":"AGGREGATION_UNSPECIFIED","promqlQueryType":"PROM_QL_QUERY_TYPE_UNSPECIFIED"},"logs":{"luceneQuery":{"value":"string"},"logsAggregation":{"count":{},"countDistinct":{},"sum":{},"average":{},"min":{},"max":{},"percentile":{}},"filters":[{}],"groupBy":[{"keypath":[]}],"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}},"spans":{"luceneQuery":{"value":"string"},"spansAggregation":{"metricAggregation":{},"dimensionAggregation":{}},"filters":[{}],"groupBy":[{}],"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"},"groupBys":[{"keypath":[]}]},"dataprime":{"dataprimeQuery":{"text":"string"},"filters":[{}],"timeFrame":{"absoluteTimeFrame":{},"relativeTimeFrame":"string"}}},"min":0.1,"max":0.1,"unit":"UNIT_UNSPECIFIED","thresholds":[{"from":0.1,"color":"string","label":"string"}],"dataModeType":"DATA_MODE_TYPE_HIGH_UNSPECIFIED","customUnit":"string","decimal":0,"thresholdType":"THRESHOLD_TYPE_UNSPECIFIED","legend":{"isVisible":true,"columns":["LEGEND_COLUMN_UNSPECIFIED"],"groupByQuery":true,"placement":"LEGEND_PLACEMENT_UNSPECIFIED"},"legendBy":"LEGEND_BY_UNSPECIFIED","customLinks":[{"id":{"value":"string"},"linkName":"string","openInNewWindow":true,"isPrivate":true,"createdBy":"string","custom":{"url":"string"},"template":{"url":"string","type":"CUSTOM_LINK_TEMPLATE_TYPE_UNSPECIFIED"}}]}},"appearance":{"width":0},"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z"}]}],"options":{"internal":{},"custom":{"name":"string","description":"string","collapsed":true,"color":{"predefined":"SECTION_PREDEFINED_COLOR_UNSPECIFIED"}}}}]},"variables":[{"name":"string","definition":{"constant":{"value":"string"},"multiSelect":{"selected":["string"],"source":{"logsPath":{"value":"string","observationField":{"keypath":["string"],"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":{"logRegex":"string"},"fieldValue":{"observationField":{"keypath":["string"],"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":{},"label":{},"operator":{}}]}}},"spansQuery":{"type":{"fieldName":{"spanRegex":"string"},"fieldValue":{"value":{"metadataField":"METADATA_FIELD_UNSPECIFIED","tagField":"string","processTagField":"string"},"observationField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}}}}},"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"}],"filters":[{"source":{"logs":{"field":"string","operator":{"equals":{"selection":{"all":{},"list":{"values":["string"]}}},"notEquals":{"selection":{"list":{"values":["string"]}}}},"observationField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"spans":{"field":{"metadataField":"METADATA_FIELD_UNSPECIFIED","tagField":"string","processTagField":"string"},"operator":{"equals":{"selection":{"all":{},"list":{"values":["string"]}}},"notEquals":{"selection":{"list":{"values":["string"]}}}},"observationField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"metrics":{"metric":"string","label":"string","operator":{"equals":{"selection":{"all":{},"list":{"values":["string"]}}},"notEquals":{"selection":{"list":{"values":["string"]}}}}}},"enabled":true,"collapsed":true}],"absoluteTimeFrame":{"from":"2019-08-24T14:15:22Z","to":"2019-08-24T14:15:22Z"},"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":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"range":{"startTimestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"},"endTimestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"duration":{"startTimestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"},"durationField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}}},"messageTemplate":"string","labelFields":[{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}]},"spans":{"luceneQuery":{"value":"string"},"strategy":{"instant":{"timestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"range":{"startTimestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"},"endTimestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}},"duration":{"startTimestampField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"},"durationField":{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}}},"messageTemplate":"string","labelFields":[{"keypath":["string"],"scope":"DATASET_SCOPE_UNSPECIFIED"}]}}}],"off":{},"twoMinutes":{},"fiveMinutes":{}},"isLocked":true}'
};

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

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

Response

200
application/json

A successful response.

The response is of type object.