dashboards

Add Widget

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

Request

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

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

unknown required

Changes

  • db5ab8f1fcefRevision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the new bar enum value to the request property

    • info

      added the new combi enum value to the request property

    • info

      added the new donut enum value to the request property

    • info

      added the new funnel enum value to the request property

    • info

      added the new gauge enum value to the request property

    • info

      added the new line enum value to the request property

    • info

      added the new metric enum value to the request property

    • info

      added the new pie enum value to the request property

    • info

      added the new scatter enum value to the request property

    • info

      added the new table enum value to the request property

    • info

      added the new text enum value to the request property

    • info

      added the new treemap enum value to the request property

    • info

      added the new waterfall enum value to the request property

    • info

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