Create widget

Creates a widget on the specified dashboard. A new widget displays a counter of active users until its options are set. For more information, see Update widget options.

Requires one of the following license types: ioa, ioaPreview, or ioe. See License Types.

Requires the Create permission on the Widgets entity (create:widget) and the Read permission on the Domains entity (read:directory). See Identity Exposure Permissions.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9]+$

Specifies the ID of the dashboard.

Body Params
number
required

Specifies the horizontal position of the widget on the dashboard grid.

number
required

Specifies the vertical position of the widget on the dashboard grid.

number
required
0 to 2147483647

Specifies the width of the widget, in dashboard grid columns.

number
required
0 to 2147483647

Specifies the height of the widget, in dashboard grid rows.

string
required

Specifies the title of the widget.

Responses

401

Returned if the API key specified in your request is invalid.

500

Returned if an internal error occurred.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json