Widgets

The Widget object represents the fundamental dynamic component of the Dashboard system.

These customizable blocks provide various filtering options, allowing you to effortlessly organize all essential information in one place.

You can find out more about widgets in our Help documentation for Dashboards under section: Widgets

Attributes

attachment_ids object
Request

IDs of attachments to associate with this widget.
attachments array of attachment
Response

Attachments linked to this widget.
column_position integer
Response Request

The horizontal column position of this widget within the dashboard grid.
content string
Response Request

The rich text or HTML content of this widget, used for note-type widgets.
dashboard dashboard
Response

The dashboard this widget belongs to.
dashboard_id integer
Request Parameter `filter`

ID of the dashboard this widget belongs to.
default_filter_id object
Request

ID of the default filter applied to this widget when no user filter is selected.
filter filter
Response

The saved filter applied to this widget's data.
filter_id integer
Request

ID of the saved filter applied to this widget's data.
height integer
Response Request

The height of this widget in dashboard grid units.
organization organization
Response

The organization this widget belongs to.
params object
Request

Additional configuration parameters for this widget's data and display.
report_layout_id integer
Request Parameter `filter`

ID of the report layout used by this widget.
row_position integer
Response Request

The vertical row position of this widget within the dashboard grid.
title string
Response Request

The display title shown at the top of this widget.
widget_type_id integer
Response Request Enum

The type of content this widget displays, such as Tasks, Report, or Note.

Enum Values (16 values)

  • 1
    Tasks
  • 2
    Activity
  • 3
    Emails
  • 4
    Projects
  • 5
    Sales
  • 6
    Unapproved time
  • 7
    Sales todos
  • 8
    Logged time
  • 9
    Unpaid amount
  • 10
    Company time
  • 11
    Utilization
  • 12
    Expenses
  • 14
    Report
  • 15
    Heading
  • 16
    Divider
  • 17
    Note
width integer
Response Request

The width of this widget in dashboard grid units.

Operations

GET /api/v2/widgets
Get all widgets
POST /api/v2/widgets
Create a widget
DELETE /api/v2/widgets/{id}
Deletes a widget
GET /api/v2/widgets/{id}
Get a widget
PATCH /api/v2/widgets/{id}
Update a widget