dashboards

Add Widget

post/api/v1/dashboards/{dashboard_id}/widgets

Path parameters

dashboard_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

widget_kind'report' | 'text'
widget_type'bar' | 'line' | 'combi' | 'pie' | 'donut' | 'treemap' | 'metric' | 'gauge' | 'funnel' | 'waterfall' | 'scatter' | 'table' | 'text' required
report_idinteger nullable
position_configobject
titlestring nullable
subtitlestring nullable
footerstring nullable

Response

Successful Response

{"stackTrail":"paths:/api/v1/dashboards/{dashboard_id}/widgets:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 6 revisions of this API.121

  • db5ab8f1fcef121See the full diff
    • request property was restricted to a list of enum values

      request-property-became-enum

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • the request property became optional

      request-property-became-optional

    • the request property became optional

      request-property-became-optional

    • added the new bar enum value to the request property

      request-property-enum-value-added

    • added the new combi enum value to the request property

      request-property-enum-value-added

    • added the new donut enum value to the request property

      request-property-enum-value-added

    • added the new funnel enum value to the request property

      request-property-enum-value-added

    • added the new gauge enum value to the request property

      request-property-enum-value-added

    • added the new line enum value to the request property

      request-property-enum-value-added

    • added the new metric enum value to the request property

      request-property-enum-value-added

    • added the new pie enum value to the request property

      request-property-enum-value-added

    • added the new scatter enum value to the request property

      request-property-enum-value-added

    • added the new table enum value to the request property

      request-property-enum-value-added

    • added the new text enum value to the request property

      request-property-enum-value-added

    • added the new treemap enum value to the request property

      request-property-enum-value-added

    • added the new waterfall enum value to the request property

      request-property-enum-value-added

    • request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened