Sign in
Dashboards

Update Dashboard

Updates an existing dashboard.

Concurrency: This endpoint does not support optimistic concurrency control. Concurrent PUT requests for the same dashboard may silently overwrite each other, which can leave orphan tile-to-container references on layout-shape edits. Clients should serialize edits to a given dashboard.

put/api/v2/dashboards/{id}

Path parameters

idstring required

Dashboard ID

Request body

namestring required

Dashboard name.

tagsstring[]

Tags for organizing and filtering dashboards.

savedQuerystring nullable

Optional default dashboard query to persist on the dashboard.

savedQueryLanguage'sql' | 'lucene'

Query language for the where clause.

Response

Successfully updated dashboard

Changes

Changed in 30 of the 60 revisions of this API.5699203

  • 3399efdca551431See the full diff
    • ▲

      the savedFilterValues/items/ request property type/format changed from object/ to /

      request-property-type-changed

    • ▲

      added SqlSavedFilterValue VariableSavedFilterValue to the data/allOf[Dashboard]/savedFilterValues/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the data/allOf[Dashboard]/savedFilterValues/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property data/allOf[Dashboard]/savedFilterValues/items/condition from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property savedFilterValues/items/condition

      request-property-removed

    • ●

      removed the request property savedFilterValues/items/type

      request-property-removed

    • ●

      removed the optional property data/allOf[Dashboard]/savedFilterValues/items/type from the response with the 200 status

      response-optional-property-removed

    • ○

      added SqlSavedFilterValue VariableSavedFilterValue to the savedFilterValues/items/ request property oneOf list

      request-property-one-of-added

  • 657a080bc54714See the full diff
    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/formulas

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/showOperandSeries

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/formulas

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/showOperandSeries

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[NumberChartConfig]/oneOf[NumberBuilderChartConfig]/formulas

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/formulas

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/showOperandSeries

      new-optional-request-property

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/formulas to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/showOperandSeries to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/formulas to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/showOperandSeries to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[NumberChartConfig]/oneOf[NumberBuilderChartConfig]/formulas to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/formulas to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/showOperandSeries to the response with the 200 status

      response-optional-property-added

  • f6841a440c386See the full diff
    • ○

      added the new optional request property filters/items/allOf[FilterInput]/isBroadcastEnabled

      new-optional-request-property

    • ○

      added the new optional request property filters/items/allOf[FilterInput]/isVariableEnabled

      new-optional-request-property

    • ○

      added the new optional request property filters/items/allOf[FilterInput]/variableName

      new-optional-request-property

    • ○

      added the optional property data/allOf[Dashboard]/filters/items/allOf[FilterInput]/isBroadcastEnabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/filters/items/allOf[FilterInput]/isVariableEnabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/filters/items/allOf[FilterInput]/variableName to the response with the 200 status

      response-optional-property-added

  • 19ec53ae02e044See the full diff
    • ▲

      the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/seriesLimit response property's min was decreased from 1.00 to 0.00 for the response status 200

      response-property-min-decreased

    • ▲

      the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[CategoricalBarChartConfig]/oneOf[CategoricalBarBuilderChartConfig]/limit response property's min was decreased from 1.00 to 0.00 for the response status 200

      response-property-min-decreased

    • ▲

      the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/seriesLimit response property's min was decreased from 1.00 to 0.00 for the response status 200

      response-property-min-decreased

    • ▲

      the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/limit response property's min was decreased from 1.00 to 0.00 for the response status 200

      response-property-min-decreased

    • ○

      the tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/seriesLimit request property's min was decreased from 1.00 to 0.00

      request-property-min-decreased

    • ○

      the tiles/items/allOf[TileBase]/config/oneOf[CategoricalBarChartConfig]/oneOf[CategoricalBarBuilderChartConfig]/limit request property's min was decreased from 1.00 to 0.00

      request-property-min-decreased

    • ○

      the tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/seriesLimit request property's min was decreased from 1.00 to 0.00

      request-property-min-decreased

    • ○

      the tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/limit request property's min was decreased from 1.00 to 0.00

      request-property-min-decreased

  • 75cd108f32f74See the full diff
    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/seriesLimit

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/seriesLimit

      new-optional-request-property

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/seriesLimit to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/seriesLimit to the response with the 200 status

      response-optional-property-added

  • b548b53bdc944See the full diff
    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[CategoricalBarChartConfig]/oneOf[CategoricalBarBuilderChartConfig]/orderBy

      new-optional-request-property

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/orderBy

      new-optional-request-property

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[CategoricalBarChartConfig]/oneOf[CategoricalBarBuilderChartConfig]/orderBy to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/orderBy to the response with the 200 status

      response-optional-property-added

  • d3f0d5ec527e15See the full diff
    • ▲

      added CategoricalBarChartConfig to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/limit

      new-optional-request-property

    • ○

      added bar discriminator mapping keys to the tiles/items/allOf[TileBase]/config request property

      request-property-discriminator-mapping-added

    • ○

      added CategoricalBarChartConfig to the tiles/items/allOf[TileBase]/config request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/limit to the response with the 200 status

      response-optional-property-added

    • ○

      added bar discriminator mapping keys to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config response property for the response status 200

      response-property-discriminator-mapping-added

  • 3f2f1a8cf0bc13See the full diff
    • ▲

      added EventPatternsChartConfig to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added event_patterns discriminator mapping keys to the tiles/items/allOf[TileBase]/config request property

      request-property-discriminator-mapping-added

    • ○

      added EventPatternsChartConfig to the tiles/items/allOf[TileBase]/config request property oneOf list

      request-property-one-of-added

    • ○

      added event_patterns discriminator mapping keys to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config response property for the response status 200

      response-property-discriminator-mapping-added

  • 323ca5de75e726See the full diff
    • ▲

      added OnClickExternal to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/onClick response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added OnClickExternal to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableRawSqlChartConfig]/allOf[subschema #2]/onClick response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added external discriminator mapping keys to the tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/onClick request property

      request-property-discriminator-mapping-added

    • ○

      added external discriminator mapping keys to the tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableRawSqlChartConfig]/allOf[subschema #2]/onClick request property

      request-property-discriminator-mapping-added

    • ○

      added OnClickExternal to the tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/onClick request property oneOf list

      request-property-one-of-added

    • ○

      added OnClickExternal to the tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableRawSqlChartConfig]/allOf[subschema #2]/onClick request property oneOf list

      request-property-one-of-added

    • ○

      added external discriminator mapping keys to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/onClick response property for the response status 200

      response-property-discriminator-mapping-added

    • ○

      added external discriminator mapping keys to the data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableRawSqlChartConfig]/allOf[subschema #2]/onClick response property for the response status 200

      response-property-discriminator-mapping-added

  • 518cd93ae7572See the full diff
    • ○

      added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[NumberChartConfig]/oneOf[NumberBuilderChartConfig]/backgroundChart

      new-optional-request-property

    • ○

      added the optional property data/allOf[Dashboard]/tiles/items/allOf[TileBase]/config/oneOf[NumberChartConfig]/oneOf[NumberBuilderChartConfig]/backgroundChart to the response with the 200 status

      response-optional-property-added