Get

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

Returns widgets for a dashboard. Use this method after Dashboard/Get or UserDashboard/Get to load the widget layout and widget metadata for one dashboard. The response returns Widget records with dashboard_id, widget type, name, grid position, size, optional firm and stock filters, connected integration id and last update time; dashboard_id is required and ids can narrow the result, while the the request supports id and dashboard filters. The request body is required, dashboard_id must be positive and results are sorted by row and column; widget type names and descriptions are translated to the current request user's language when translations exist. Business errors such as missing body, missing dashboard_id, invalid filters, database errors and translation lookup failures are returned as 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
    }
  ]
}