Get

[POST] .../v1/widget/get

Returns widgets for a dashboard. Retrieve the widget layout for a dashboard selected through Dashboard/Get or UserDashboard/Get. Requires a positive dashboard_id; filters can narrow the widget list. Returns Widget records with positions, sizes, widget types and configured filters, ordered by row and column. Widget names and descriptions use translations for the current request user when available. Missing body, invalid dashboard_id, invalid filters, translation failures and storage errors return HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
dashboard_id int Dashboard ID. The method requires a positive dashboard_id.
id int Widget IDs. Can be provided through filters.

Request Example

{
  "filters": [
    {
      "Field": "dashboard_id",
      "Operator": "Equal",
      "Value": "3"
    },
    {
      "Field": "id",
      "Operator": "In",
      "Value": "15"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of Widget Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 15,
      "name": "Retail sales",
      "widget_type": {
        "id": 6,
        "name": "Retail sale stats",
        "name_key": "RETAIL_SALE_STATS",
        "description": "Retail sale statistics",
        "last_update": 0
      },
      "dashboard_id": 3,
      "row": 0,
      "column": 0,
      "width": 4,
      "height": 2,
      "firm_id": 10,
      "stock_id": 4,
      "connected_integration_id": null,
      "last_update": 1712345600
    }
  ]
}