Dashboards

Download InfluxDB Cloud (TSM) API Spec
Create and manage dashboards in InfluxDB Cloud.
GET /api/v2/dashboards

List dashboards

Lists dashboards.

Parameters

Query parameters
offset integer

The offset for pagination. The number of records to skip.

For more information about pagination parameters, see Pagination.

descending boolean
limit integer
The maximum number of dashboards to return. Default is 20. The minimum is -1 and the maximum is 100.
Default: 20
owner string
A user ID. Only returns dashboards where the specified user has the owner role.
sortBy string
The column to sort by.
Allowed values: ID , CreatedAt , UpdatedAt
id array
A list of dashboard IDs. Returns only the specified dashboards. If you specify id and owner, only id is used.
orgID string
An organization ID. Only returns dashboards that belong to the specified organization.
org string
An organization name. Only returns dashboards that belong to the specified organization.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. The response body contains dashboards.
dashboards object[]
cells object[]
h integer <int32>
id string
links object
viewID string
The reference to a view from the views API.
w integer <int32>
x integer <int32>
y integer <int32>
description string
The user-facing description of the dashboard.
id string
labels object[]
id string
name string
orgID string
properties object
Key-value pairs associated with this label. To remove a property, send an update with an empty value ("") for the key.
Example: {"color":"ffb3b3","description":"this is a description"}
links object
Example: {"cells":"/api/v2/dashboards/1/cells","labels":"/api/v2/dashboards/1/labels","members":"/api/v2/dashboards/1/members","org":"/api/v2/labels/1","owners":"/api/v2/dashboards/1/owners","self":"/api/v2/dashboards/1"}
cells string <uri>
URI of resource.
labels string <uri>
URI of resource.
members string <uri>
URI of resource.
org string <uri>
URI of resource.
owners string <uri>
URI of resource.
self string <uri>
URI of resource.
meta object
createdAt string <date-time>
updatedAt string <date-time>
name required string
The user-facing name of the dashboard.
orgID required string
The ID of the organization that owns the dashboard.
links object
URI pointers for additional paged results.
next string <uri>
URI of resource.
prev string <uri>
URI of resource.
self required string <uri>
URI of resource.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
POST /api/v2/dashboards

Create a dashboard

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Dashboard to create
Content-Type: application/json
description string
The user-facing description of the dashboard.
name required string
The user-facing name of the dashboard.
orgID required string
The ID of the organization that owns the dashboard.
Example request Ask AI about this
curl --request POST \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "description": "DESCRIPTION",
  "name": "NAME",
  "orgID": "ORGID"
}'

Responses

201 Success. The dashboard is created.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2/dashboards/{dashboardID}

Retrieve a dashboard

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to update.
Query parameters
include string
If properties, includes the cell view properties in the response.
Allowed values: properties
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Retrieve a single dashboard
404 Dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
PATCH /api/v2/dashboards/{dashboardID}

Update a dashboard

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to update.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Patching of a dashboard
Content-Type: application/json
cells object
h integer <int32>
id string
links object
self string
view string
name string
properties object or object or object or object or object or object or object or object or object or object or object or object or object or object
One of: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
colors required object[]
Colors define color encoding of data into a visualization
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
generateXAxisTicks string[]
generateYAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
prefix required string
queries required object[]
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
suffix required string
timeFormat string
type required string
Allowed: line-plus-single-stat
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
colorMapping object
A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
Example: {"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}
colors required object[]
Colors define color encoding of data into a visualization
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
timeFormat string
type required string
Allowed: xy
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required object[]
Colors define color encoding of data into a visualization
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
note required string
prefix required string
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: single-stat
Or: object
binCount required integer
colors required object[]
Colors define color encoding of data into a visualization
fillColumns required string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: histogram
xAxisLabel required string
xColumn required string
xDomain required number[]
Or: object
colors required object[]
Colors define color encoding of data into a visualization
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
note required string
prefix required string
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: gauge
Or: object
colors required object[]
Colors define color encoding of data into a visualization
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
fieldOptions required object[]
fieldOptions represent the fields retrieved by the query with customization options
note required string
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
tableOptions required object
timeFormat required string
timeFormat describes the display format for time values according to moment.js date formatting
type required string
Allowed: table
Or: object
note required string
queries required object[]
shape required string
Allowed: chronograf-v2
showAll required boolean
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: simple-table
Or: object
note required string
shape required string
Allowed: chronograf-v2
type required string
Allowed: markdown
Or: object
adaptiveZoomHide boolean
check object or object or object
checkID required string
colors required object[]
Colors define color encoding of data into a visualization
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
queries required object[]
shape required string
Allowed: chronograf-v2
type required string
Allowed: check
Or: object
adaptiveZoomHide boolean
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
symbolColumns required string[]
timeFormat string
type required string
Allowed: scatter
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
binSize required number
colors required string[]
Colors define color encoding of data into a visualization
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: heatmap
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: mosaic
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yDomain required number[]
yLabelColumnSeparator string
yLabelColumns string[]
yPrefix required string
ySeriesColumns required string[]
ySuffix required string
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
colors required object[]
Colors define color encoding of data into a visualization
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
lowerColumn string
mainColumn string
note required string
queries required object[]
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
timeFormat string
type required string
Allowed: band
upperColumn string
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
allowPanAndZoom required boolean
If true, map zoom and pan controls are enabled on the dashboard view
Default: true
center required object
Coordinates of the center of the map
colors object[]
Colors define color encoding of data into a visualization
detectCoordinateFields required boolean
If true, search results get automatically regroupped so that lon,lat and value are treated as columns
Default: true
latLonColumns object
Object type to define lat/lon columns
layers required object[]
List of individual layers shown in the map
mapStyle string
Define map type - regular, satellite etc.
note required string
queries required object[]
s2Column string
String to define the column
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: geo
useS2CellID boolean
If true, S2 column is used to calculate lat/lon
zoom required number <double>
Zoom level used for initial display of the map
viewID string
The reference to a view from the views API.
w integer <int32>
x integer <int32>
y integer <int32>
description string
optional, when provided will replace the description
name string
optional, when provided will replace the name
Example request Ask AI about this
curl --request PATCH \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "cells": {
    "h": 0,
    "id": "ID",
    "links": {
      "self": "SELF",
      "view": "VIEW"
    },
    "name": "NAME",
    "properties": {},
    "viewID": "VIEWID",
    "w": 0,
    "x": 0,
    "y": 0
  },
  "description": "DESCRIPTION",
  "name": "NAME"
}'

Responses

200 Updated dashboard
404 Dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
DELETE /api/v2/dashboards/{dashboardID}

Delete a dashboard

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to update.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request DELETE \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Delete has been accepted
404 Dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
POST /api/v2/dashboards/{dashboardID}/cells

Create a dashboard cell

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to update.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Cell that will be added
Content-Type: application/json
h integer <int32>
name string
usingView string
Makes a copy of the provided view.
w integer <int32>
x integer <int32>
y integer <int32>
Example request Ask AI about this
curl --request POST \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/cells" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "h": 0,
  "name": "NAME",
  "usingView": "USINGVIEW",
  "w": 0,
  "x": 0,
  "y": 0
}'

Responses

201 Cell successfully added
h integer <int32>
id string
links object
self string
view string
viewID string
The reference to a view from the views API.
w integer <int32>
x integer <int32>
y integer <int32>
404 Dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
PUT /api/v2/dashboards/{dashboardID}/cells

Replace cells in a dashboard

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to update.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Content-Type: application/json
Example request Ask AI about this
curl --request PUT \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/cells" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json"

Responses

201 Replaced dashboard cells
404 Dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
PATCH /api/v2/dashboards/{dashboardID}/cells/{cellID}

Update the non-positional information related to a cell

Updates the non positional information related to a cell. Updates to a single cell’s positional data could cause grid conflicts.

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to update.
cellID required string
The ID of the cell to update.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Content-Type: application/json
h integer <int32>
w integer <int32>
x integer <int32>
y integer <int32>
Example request Ask AI about this
curl --request PATCH \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/cells/{cellID}" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "h": 0,
  "w": 0,
  "x": 0,
  "y": 0
}'

Responses

200 Updated dashboard cell
h integer <int32>
id string
links object
self string
view string
viewID string
The reference to a view from the views API.
w integer <int32>
x integer <int32>
y integer <int32>
404 Cell or dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
DELETE /api/v2/dashboards/{dashboardID}/cells/{cellID}

Delete a dashboard cell

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to delete.
cellID required string
The ID of the cell to delete.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request DELETE \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/cells/{cellID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Cell successfully deleted
404 Cell or dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2/dashboards/{dashboardID}/cells/{cellID}/view

Retrieve the view for a cell

Parameters

Path parameters
dashboardID required string
The dashboard ID.
cellID required string
The cell ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/cells/{cellID}/view" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 A dashboard cells view
id string
links object
self string
name required string
properties required object or object or object or object or object or object or object or object or object or object or object or object or object or object
One of: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
generateXAxisTicks string[]
generateYAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
suffix required string
timeFormat string
type required string
Allowed: line-plus-single-stat
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colorMapping object
A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
Example: {"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
timeFormat string
type required string
Allowed: xy
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
note required string
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: single-stat
Or: object
binCount required integer
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
fillColumns required string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: histogram
xAxisLabel required string
xColumn required string
xDomain required number[]
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
note required string
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: gauge
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
fieldOptions required object[]
fieldOptions represent the fields retrieved by the query with customization options
displayName string
The name that a field is renamed to by the user.
internalName string
The calculated name of a field.
visible boolean
Indicates whether this field should be visible on the table.
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
tableOptions required object
fixFirstColumn boolean
fixFirstColumn indicates whether the first column of the table should be locked
sortBy object
Describes a field that can be renamed and made visible or invisible.
verticalTimeAxis boolean
verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically
wrapping string
Wrapping describes the text wrapping style to be used in table views
Allowed: truncate , wrap , single-line
timeFormat required string
timeFormat describes the display format for time values according to moment.js date formatting
type required string
Allowed: table
Or: object
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showAll required boolean
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: simple-table
Or: object
note required string
shape required string
Allowed: chronograf-v2
type required string
Allowed: markdown
Or: object
adaptiveZoomHide boolean
check object or object or object
One of: object
createdAt string <date-time>
description string
An optional description of the check.
every string
Check repetition interval.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
level string
The state to record if check matches a criteria.
Allowed: UNKNOWN , OK , INFO , CRIT , WARN
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
offset string
Duration to delay after the schedule, before executing check.
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
reportZero boolean
If only zero values reported since time, trigger an alert
staleTime string
String duration for time that a series is considered stale and should not trigger deadman.
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
statusMessageTemplate string
The template used to generate and write a status message.
tags object[]
List of tags to write to each status.
taskID string
The ID of the task associated with this check.
timeSince string
String duration before deadman triggers.
type required string
Allowed: deadman
updatedAt string <date-time>
Or: object
createdAt string <date-time>
description string
An optional description of the check.
every string
Check repetition interval.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
offset string
Duration to delay after the schedule, before executing check.
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
statusMessageTemplate string
The template used to generate and write a status message.
tags object[]
List of tags to write to each status.
taskID string
The ID of the task associated with this check.
thresholds object[]
type required string
Allowed: threshold
updatedAt string <date-time>
Or: object
createdAt string <date-time>
description string
An optional description of the check.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
taskID string
The ID of the task associated with this check.
type required string
Allowed: custom
updatedAt string <date-time>
checkID required string
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
type required string
Allowed: check
Or: object
adaptiveZoomHide boolean
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
symbolColumns required string[]
timeFormat string
type required string
Allowed: scatter
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
binSize required number
colors required string[]
Colors define color encoding of data into a visualization
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: heatmap
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: mosaic
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yDomain required number[]
yLabelColumnSeparator string
yLabelColumns string[]
yPrefix required string
ySeriesColumns required string[]
ySuffix required string
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
lowerColumn string
mainColumn string
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
timeFormat string
type required string
Allowed: band
upperColumn string
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
allowPanAndZoom required boolean
If true, map zoom and pan controls are enabled on the dashboard view
Default: true
center required object
Coordinates of the center of the map
lat required number <double>
Latitude of the center of the map
lon required number <double>
Longitude of the center of the map
colors object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
detectCoordinateFields required boolean
If true, search results get automatically regroupped so that lon,lat and value are treated as columns
Default: true
latLonColumns object
Object type to define lat/lon columns
lat required object
Object type for key and column definitions
lon required object
Object type for key and column definitions
layers required object[]
List of individual layers shown in the map
mapStyle string
Define map type - regular, satellite etc.
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
s2Column string
String to define the column
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: geo
useS2CellID boolean
If true, S2 column is used to calculate lat/lon
zoom required number <double>
Zoom level used for initial display of the map
404 Cell or dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
PATCH /api/v2/dashboards/{dashboardID}/cells/{cellID}/view

Update the view for a cell

Parameters

Path parameters
dashboardID required string
The ID of the dashboard to update.
cellID required string
The ID of the cell to update.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Content-Type: application/json
id string
links object
self string
name required string
properties required object or object or object or object or object or object or object or object or object or object or object or object or object or object
One of: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
generateXAxisTicks string[]
generateYAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
suffix required string
timeFormat string
type required string
Allowed: line-plus-single-stat
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colorMapping object
A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
Example: {"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
timeFormat string
type required string
Allowed: xy
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
note required string
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: single-stat
Or: object
binCount required integer
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
fillColumns required string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: histogram
xAxisLabel required string
xColumn required string
xDomain required number[]
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
note required string
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: gauge
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
fieldOptions required object[]
fieldOptions represent the fields retrieved by the query with customization options
displayName string
The name that a field is renamed to by the user.
internalName string
The calculated name of a field.
visible boolean
Indicates whether this field should be visible on the table.
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
tableOptions required object
fixFirstColumn boolean
fixFirstColumn indicates whether the first column of the table should be locked
sortBy object
Describes a field that can be renamed and made visible or invisible.
verticalTimeAxis boolean
verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically
wrapping string
Wrapping describes the text wrapping style to be used in table views
Allowed: truncate , wrap , single-line
timeFormat required string
timeFormat describes the display format for time values according to moment.js date formatting
type required string
Allowed: table
Or: object
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showAll required boolean
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: simple-table
Or: object
note required string
shape required string
Allowed: chronograf-v2
type required string
Allowed: markdown
Or: object
adaptiveZoomHide boolean
check object or object or object
One of: object
createdAt string <date-time>
description string
An optional description of the check.
every string
Check repetition interval.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
level string
The state to record if check matches a criteria.
Allowed: UNKNOWN , OK , INFO , CRIT , WARN
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
offset string
Duration to delay after the schedule, before executing check.
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
reportZero boolean
If only zero values reported since time, trigger an alert
staleTime string
String duration for time that a series is considered stale and should not trigger deadman.
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
statusMessageTemplate string
The template used to generate and write a status message.
tags object[]
List of tags to write to each status.
taskID string
The ID of the task associated with this check.
timeSince string
String duration before deadman triggers.
type required string
Allowed: deadman
updatedAt string <date-time>
Or: object
createdAt string <date-time>
description string
An optional description of the check.
every string
Check repetition interval.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
offset string
Duration to delay after the schedule, before executing check.
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
statusMessageTemplate string
The template used to generate and write a status message.
tags object[]
List of tags to write to each status.
taskID string
The ID of the task associated with this check.
thresholds object[]
type required string
Allowed: threshold
updatedAt string <date-time>
Or: object
createdAt string <date-time>
description string
An optional description of the check.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
taskID string
The ID of the task associated with this check.
type required string
Allowed: custom
updatedAt string <date-time>
checkID required string
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
type required string
Allowed: check
Or: object
adaptiveZoomHide boolean
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
symbolColumns required string[]
timeFormat string
type required string
Allowed: scatter
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
binSize required number
colors required string[]
Colors define color encoding of data into a visualization
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: heatmap
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: mosaic
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yDomain required number[]
yLabelColumnSeparator string
yLabelColumns string[]
yPrefix required string
ySeriesColumns required string[]
ySuffix required string
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
lowerColumn string
mainColumn string
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
timeFormat string
type required string
Allowed: band
upperColumn string
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
allowPanAndZoom required boolean
If true, map zoom and pan controls are enabled on the dashboard view
Default: true
center required object
Coordinates of the center of the map
lat required number <double>
Latitude of the center of the map
lon required number <double>
Longitude of the center of the map
colors object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
detectCoordinateFields required boolean
If true, search results get automatically regroupped so that lon,lat and value are treated as columns
Default: true
latLonColumns object
Object type to define lat/lon columns
lat required object
Object type for key and column definitions
lon required object
Object type for key and column definitions
layers required object[]
List of individual layers shown in the map
mapStyle string
Define map type - regular, satellite etc.
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
s2Column string
String to define the column
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: geo
useS2CellID boolean
If true, S2 column is used to calculate lat/lon
zoom required number <double>
Zoom level used for initial display of the map
Example request Ask AI about this
curl --request PATCH \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/cells/{cellID}/view" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "id": "ID",
  "links": {
    "self": "SELF"
  },
  "name": "NAME",
  "properties": {
    "adaptiveZoomHide": false,
    "axes": {},
    "colors": [],
    "decimalPlaces": {},
    "generateXAxisTicks": [],
    "generateYAxisTicks": [],
    "hoverDimension": "auto",
    "legendColorizeRows": false,
    "legendHide": false,
    "legendOpacity": 0,
    "legendOrientationThreshold": 0,
    "note": "NOTE",
    "position": "overlaid",
    "prefix": "PREFIX",
    "queries": [],
    "shadeBelow": false,
    "shape": "chronograf-v2",
    "showNoteWhenEmpty": false,
    "staticLegend": {},
    "suffix": "SUFFIX",
    "timeFormat": "TIMEFORMAT",
    "type": "line-plus-single-stat",
    "xColumn": "XCOLUMN",
    "xTickStart": 0,
    "xTickStep": 0,
    "xTotalTicks": 0,
    "yColumn": "YCOLUMN",
    "yTickStart": 0,
    "yTickStep": 0,
    "yTotalTicks": 0
  }
}'

Responses

200 Updated cell view
id string
links object
self string
name required string
properties required object or object or object or object or object or object or object or object or object or object or object or object or object or object
One of: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
generateXAxisTicks string[]
generateYAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
suffix required string
timeFormat string
type required string
Allowed: line-plus-single-stat
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colorMapping object
A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
Example: {"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shadeBelow boolean
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
timeFormat string
type required string
Allowed: xy
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
note required string
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: single-stat
Or: object
binCount required integer
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
fillColumns required string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
position required string
Allowed: overlaid , stacked
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: histogram
xAxisLabel required string
xColumn required string
xDomain required number[]
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
note required string
prefix required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
suffix required string
tickPrefix required string
tickSuffix required string
type required string
Allowed: gauge
Or: object
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
decimalPlaces required object
Indicates whether decimal places should be enforced, and how many digits it should show.
digits integer <int32>
The number of digits after decimal to display
isEnforced boolean
Indicates whether decimal point setting should be enforced
fieldOptions required object[]
fieldOptions represent the fields retrieved by the query with customization options
displayName string
The name that a field is renamed to by the user.
internalName string
The calculated name of a field.
visible boolean
Indicates whether this field should be visible on the table.
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
tableOptions required object
fixFirstColumn boolean
fixFirstColumn indicates whether the first column of the table should be locked
sortBy object
Describes a field that can be renamed and made visible or invisible.
verticalTimeAxis boolean
verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically
wrapping string
Wrapping describes the text wrapping style to be used in table views
Allowed: truncate , wrap , single-line
timeFormat required string
timeFormat describes the display format for time values according to moment.js date formatting
type required string
Allowed: table
Or: object
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showAll required boolean
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: simple-table
Or: object
note required string
shape required string
Allowed: chronograf-v2
type required string
Allowed: markdown
Or: object
adaptiveZoomHide boolean
check object or object or object
One of: object
createdAt string <date-time>
description string
An optional description of the check.
every string
Check repetition interval.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
level string
The state to record if check matches a criteria.
Allowed: UNKNOWN , OK , INFO , CRIT , WARN
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
offset string
Duration to delay after the schedule, before executing check.
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
reportZero boolean
If only zero values reported since time, trigger an alert
staleTime string
String duration for time that a series is considered stale and should not trigger deadman.
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
statusMessageTemplate string
The template used to generate and write a status message.
tags object[]
List of tags to write to each status.
taskID string
The ID of the task associated with this check.
timeSince string
String duration before deadman triggers.
type required string
Allowed: deadman
updatedAt string <date-time>
Or: object
createdAt string <date-time>
description string
An optional description of the check.
every string
Check repetition interval.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
offset string
Duration to delay after the schedule, before executing check.
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
statusMessageTemplate string
The template used to generate and write a status message.
tags object[]
List of tags to write to each status.
taskID string
The ID of the task associated with this check.
thresholds object[]
type required string
Allowed: threshold
updatedAt string <date-time>
Or: object
createdAt string <date-time>
description string
An optional description of the check.
id string
labels object[]
lastRunError string
lastRunStatus string
Allowed: failed , success , canceled
latestCompleted string <date-time>
A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
links object
Example: {"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}
name required string
orgID required string
The ID of the organization that owns this check.
ownerID string
The ID of creator used to create this check.
query required object
status string
inactive cancels scheduled runs and prevents manual runs of the task.
Allowed: active , inactive
taskID string
The ID of the task associated with this check.
type required string
Allowed: custom
updatedAt string <date-time>
checkID required string
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
type required string
Allowed: check
Or: object
adaptiveZoomHide boolean
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
symbolColumns required string[]
timeFormat string
type required string
Allowed: scatter
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
adaptiveZoomHide boolean
binSize required number
colors required string[]
Colors define color encoding of data into a visualization
generateXAxisTicks string[]
generateYAxisTicks string[]
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: heatmap
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yColumn required string
yDomain required number[]
yPrefix required string
ySuffix required string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
colors required string[]
Colors define color encoding of data into a visualization
fillColumns required string[]
generateXAxisTicks string[]
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
timeFormat string
type required string
Allowed: mosaic
xAxisLabel required string
xColumn required string
xDomain required number[]
xPrefix required string
xSuffix required string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yAxisLabel required string
yDomain required number[]
yLabelColumnSeparator string
yLabelColumns string[]
yPrefix required string
ySeriesColumns required string[]
ySuffix required string
Or: object
adaptiveZoomHide boolean
axes required object
The viewport for a View’s visualizations
x required object
Axis used in a visualization.
y required object
Axis used in a visualization.
colors required object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
generateXAxisTicks string[]
generateYAxisTicks string[]
geom required string
Allowed: line , step , stacked , bar , monotoneX , stepBefore , stepAfter
hoverDimension string
Allowed: auto , x , y , xy
legendColorizeRows boolean
legendHide boolean
legendOpacity number <float>
legendOrientationThreshold integer
lowerColumn string
mainColumn string
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
staticLegend object
StaticLegend represents the options specific to the static legend
colorizeRows boolean
heightRatio number <float>
opacity number <float>
orientationThreshold integer
show boolean
valueAxis string
widthRatio number <float>
timeFormat string
type required string
Allowed: band
upperColumn string
xColumn string
xTickStart number <float>
xTickStep number <float>
xTotalTicks integer
yColumn string
yTickStart number <float>
yTickStep number <float>
yTotalTicks integer
Or: object
allowPanAndZoom required boolean
If true, map zoom and pan controls are enabled on the dashboard view
Default: true
center required object
Coordinates of the center of the map
lat required number <double>
Latitude of the center of the map
lon required number <double>
Longitude of the center of the map
colors object[]
Colors define color encoding of data into a visualization
hex required string
The hex number of the color
id required string
The unique ID of the view color.
name required string
The user-facing name of the hex color.
type required string
Type is how the color is used.
Allowed: min , max , threshold , scale , text , background
value required number <float>
The data value mapped to this color.
detectCoordinateFields required boolean
If true, search results get automatically regroupped so that lon,lat and value are treated as columns
Default: true
latLonColumns object
Object type to define lat/lon columns
lat required object
Object type for key and column definitions
lon required object
Object type for key and column definitions
layers required object[]
List of individual layers shown in the map
mapStyle string
Define map type - regular, satellite etc.
note required string
queries required object[]
builderConfig object
editMode string
Allowed: builder , advanced
name string
text string
The text of the Flux query.
s2Column string
String to define the column
shape required string
Allowed: chronograf-v2
showNoteWhenEmpty required boolean
If true, will display note when empty
type required string
Allowed: geo
useS2CellID boolean
If true, S2 column is used to calculate lat/lon
zoom required number <double>
Zoom level used for initial display of the map
404 Cell or dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2/dashboards/{dashboardID}/labels

List all labels for a dashboard

Parameters

Path parameters
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/labels" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 A list of all labels for a dashboard
labels object[]
id string
name string
orgID string
properties object
Key-value pairs associated with this label. To remove a property, send an update with an empty value ("") for the key.
Example: {"color":"ffb3b3","description":"this is a description"}
links object
URI pointers for additional paged results.
next string <uri>
URI of resource.
prev string <uri>
URI of resource.
self required string <uri>
URI of resource.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
POST /api/v2/dashboards/{dashboardID}/labels

Add a label to a dashboard

Parameters

Path parameters
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

Label to add
Content-Type: application/json
labelID required string
A label ID. Specifies the label to attach.
Example request Ask AI about this
curl --request POST \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/labels" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "labelID": "LABELID"
}'

Responses

201 The label added to the dashboard
label object
id string
name string
orgID string
properties object
Key-value pairs associated with this label. To remove a property, send an update with an empty value ("") for the key.
Example: {"color":"ffb3b3","description":"this is a description"}
links object
URI pointers for additional paged results.
next string <uri>
URI of resource.
prev string <uri>
URI of resource.
self required string <uri>
URI of resource.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
DELETE /api/v2/dashboards/{dashboardID}/labels/{labelID}

Delete a label from a dashboard

Parameters

Path parameters
dashboardID required string
The dashboard ID.
labelID required string
The ID of the label to delete.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request DELETE \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/labels/{labelID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Delete has been accepted
404 Dashboard not found
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2/dashboards/{dashboardID}/members

List all dashboard members

Parameters

Path parameters
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/members" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 A list of users who have member privileges for a dashboard
links object
self string <uri>
users object[]
id string
The user ID.
links object
Example: {"self":"/api/v2/users/1"}
self string <uri>
name required string
The user name.
role string
Allowed: member
Default: member
status string
The status of a user. An inactive user can’t read or write resources.
Allowed: active , inactive
Default: active
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
POST /api/v2/dashboards/{dashboardID}/members

Add a member to a dashboard

Parameters

Path parameters
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

User to add as member
Content-Type: application/json
id required string
The ID of the user to add to the resource.
name string
The name of the user to add to the resource.
Example request Ask AI about this
curl --request POST \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/members" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "id": "ID",
  "name": "NAME"
}'

Responses

201 Added to dashboard members
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
DELETE /api/v2/dashboards/{dashboardID}/members/{userID}

Remove a member from a dashboard

Parameters

Path parameters
userID required string
The ID of the member to remove.
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request DELETE \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/members/{userID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Member removed
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2/dashboards/{dashboardID}/owners

List all dashboard owners

Parameters

Path parameters
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/owners" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 A list of users who have owner privileges for a dashboard
links object
self string <uri>
users object[]
id string
The user ID.
links object
Example: {"self":"/api/v2/users/1"}
self string <uri>
name required string
The user name.
role string
Allowed: owner
Default: owner
status string
The status of a user. An inactive user can’t read or write resources.
Allowed: active , inactive
Default: active
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
POST /api/v2/dashboards/{dashboardID}/owners

Add an owner to a dashboard

Parameters

Path parameters
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context

Request body required

User to add as owner
Content-Type: application/json
id required string
The ID of the user to add to the resource.
name string
The name of the user to add to the resource.
Example request Ask AI about this
curl --request POST \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/owners" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "id": "ID",
  "name": "NAME"
}'

Responses

201 Added to dashboard owners
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
DELETE /api/v2/dashboards/{dashboardID}/owners/{userID}

Remove an owner from a dashboard

Parameters

Path parameters
userID required string
The ID of the owner to remove.
dashboardID required string
The dashboard ID.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request DELETE \
  "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dashboards/{dashboardID}/owners/{userID}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Owner removed
default Unexpected error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.

Was this page helpful?

Thank you for your feedback!