WHERE DO I START?
You are here:... (Miscellaneous) > API > Widgets
  • Top ↑

Widgets

The widgets API allows you access to the widgets your dashboards.

Tip   To explore Netuitive's REST API and test some requests, go here.

Get a list of widgets on a dashboard

This method will return a list of widgets associated with a dashboard.

Method GET URL https://api.app.netuitive.com/widgets
Parameters Required/Optional Description
dashboardId Required Query parameter. The ID of the dashboard you're trying to get the widgets for.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Create a widget

This method creates a widget.

Method POST URL https://api.app.netuitive.com/widgets
Parameters Required/Optional Description
widget Required Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
created Optional The time the widget was created. This must be in ISO 8601 format.
dashboardId Optional The ID of the dashboard you're trying to put the widget in.
id Optional The ID for the widget. If you leave this field blank, Netuitive will create an ID for you.
name Optional The name of the widget.
properties Optional

The properties for the widget; this object will vary depending on the type of widget. You can read more about the widget types and their properties here.

updated Optional The time the widget was last updated. This must be in ISO 8601 format.
userId Optional The ID of the user who created the widget. If you leave this field blank, Netuitive will use your user ID.
widgetType Optional The type of widget. Options include:
  • cpu-usage
  • integration-aggregate (EC2 Aggregate)
  • element-attributes
  • element-relationships
  • element-tags
  • event-ticker
  • group-event-summary
  • group-status
  • high-low-metric
  • memory-usage
  • metric-agg
  • metric-count-agg
  • metric-status
  • metric-time-series
  • multi-metric-table
  • multi-metric-time-series
  • stacked-area

Delete a widget

This method will delete a given widget.

Method DELETE URL https://api.app.netuitive.com/widgets/{id}
Important   Replace {id} in the above URL with the ID from any of your integrations.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the widget.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get widget by ID

This method will return a widget for the given ID.

Method GET URL https://api.app.netuitive.com/widgets/{id}
Parameters Required/Optional Description
id Required URL (path) parameter. The ID for the widget.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Update a widget

This method will update a given widget.

Method PUT URL https://api.app.netuitive.com/widgets/{id}
Parameters Required/Optional Description
id Required URL (path) parameter. The ID for the widget.
widget Required Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
created Optional The time the widget was created. This must be in ISO 8601 format.
dashboardId Optional The ID of the dashboard you're trying to put the widget in.
id Optional The ID for the widget. If you leave this field blank, Netuitive will create an ID for you.
name Optional The name of the widget.
properties Optional

The properties for the widget; this object will vary depending on the type of widget. You can read more about the widget types and their properties here.

updated Optional The time the widget was last updated. This must be in ISO 8601 format.
userId Optional The ID of the user who created the widget. If you leave this field blank, Netuitive will use your user ID.
widgetType Optional The type of widget. Options include:
  • cpu-usage
  • integration-aggregate (EC2 Aggregate)
  • element-attributes
  • element-relationships
  • element-tags
  • event-ticker
  • group-event-summary
  • group-status
  • high-low-metric
  • memory-usage
  • metric-agg
  • metric-count-agg
  • metric-status
  • metric-time-series
  • multi-metric-table
  • multi-metric-time-series
  • stacked-area