ROroarkhq
Dashboard

Replace a widget

Changed on

Replaces a widget's definition. It keeps its id and its place on the dashboard.

put/v1/dashboard/{dashboardId}/widget/{widgetId}

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/dashboard/{dashboardId}/widget/{widgetId}
  • Auth
    HTTP bearer

Path parameters

dashboardIdstring uuid required

The dashboard ID

widgetIdstring uuid required

The widget ID

Request body

interval'HOUR' | 'DAY' | 'WEEK' | 'MONTH'

Bucket size. Defaults from the window's length and steps coarser when the window would exceed 500 buckets.

comparisonMode'NONE' | 'PREVIOUS_PERIOD'

PREVIOUS_PERIOD adds the preceding window of the same length to every series.

namestring required

Unique on the dashboard: how the widget is matched on update.

descriptionstring
display'LINE' | 'NUMBER' | 'RADAR' | 'STACKED_BAR' | 'TABLE'

Chart type. Defaults to LINE.

size'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE'

Grid width. Defaults to MEDIUM.

Example request

{
  "name": "Sentiment",
  "display": "LINE",
  "size": "LARGE",
  "interval": "DAY",
  "measures": [
    {
      "metric": "sentiment_score",
      "aggregation": "AVG"
    }
  ]
}

Response

The updated widget

Changes

  • 8913d3b08c7bRevision changes
    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property ///// became optional for the status

    • warning

      added the new IS_NOT_SET enum value to the ///// response property for the response status

    • warning

      added the new IS_NOT_SET enum value to the /// response property for the response status

    • warning

      added the new IS_NOT_SET enum value to the ///// response property for the response status

    • warning

      added the new IS_NOT_SET enum value to the /// response property for the response status

    • warning

      added the new IS_SET enum value to the ///// response property for the response status

    • warning

      added the new IS_SET enum value to the /// response property for the response status

    • warning

      added the new IS_SET enum value to the ///// response property for the response status

    • warning

      added the new IS_SET enum value to the /// response property for the response status

    • info

      the request property //// became optional

    • info

      the request property // became optional

    • info

      the request property //// became optional

    • info

      added the new IS_NOT_SET enum value to the request property ////

    • info

      added the new IS_NOT_SET enum value to the request property //

    • info

      added the new IS_NOT_SET enum value to the request property ////

    • info

      added the new IS_NOT_SET enum value to the request property //

    • info

      added the new IS_SET enum value to the request property ////

    • info

      added the new IS_SET enum value to the request property //

    • info

      added the new IS_SET enum value to the request property ////

    • info

      added the new IS_SET enum value to the request property //

  • 2e403107d6ecRevision changes
    • info

      endpoint added