Widgets

Update Widget

Changed on

Replace a widget's configuration and metrics (full replace; data_type cannot change).

put/v1/widgets/{widget_id}

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/widgets/{widget_id}
  • Auth
    HTTPBearer (a scheme the document does not define)

Path parameters

widget_idstring required

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

namestring required
descriptionstring nullable
chart_type'line' | 'bar' | 'pie' | 'table' | 'kpi' | 'pivot_table' | 'histogram' required
chart_mode'time_series' | 'categorical' nullable
bar_mode'stacked' | 'side_by_side' nullable
aggregationstring[]
time_bucket'hour' | 'day' | 'week' | 'month' nullable
simulation_idsinteger[]
show_indeterminateboolean
column_visibilityobject nullable
color_overridesobject nullable
show_legendboolean nullable

Response

Successful Response

idstring required
organization_idstring nullable
namestring required
descriptionstring nullable
chart_typestring required
chart_modestring nullable
data_typestring required
applies_to_all_agentsboolean
bar_modestring nullable
aggregationstring[] nullable
time_bucketstring nullable
group_bystring nullable
simulation_idsinteger[] nullable
show_indeterminateboolean nullable
filtersunknown
column_visibilityunknown
color_overridesobject nullable

The colour the chart draws each series or slice in, keyed by its label lowercased. Written whole when a widget is saved, so it names every label rather than only the ones a person changed.

show_legendboolean

Whether the chart draws its colour key

created_bystring nullable
created_atstring nullable
updated_atstring nullable

Changes

  • 82e1eddb5e18Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

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

    • info

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

    • info

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

  • aa501502e1fcRevision changes
    • info

      added the new optional header request parameter X-Organization-Id