dashboards

Update Widget

Changed on

Update a widget's config, title, viz type, or position.

put/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}

Request

  • Base URL: https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.getanana.com/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}
  • Auth: none declared

Path parameters

dashboard_idstring uuid required
widget_idstring uuid required

Request body

titlestring nullable
viz_type'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap'
configobject nullable
positionobject nullable

Response

Successful Response

idstring uuid required
dashboard_idstring uuid required
titlestring required
viz_type'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap' required
configobject required
positionobject required
is_systemboolean
source_kind'system' | 'user' nullable
source_refstring nullable
source_config_snapshotobject nullable
source_viz_snapshot'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap'
created_atstring date-time required
updated_atstring date-time required

Changes

  • d65b8fefae34Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status