Get

[POST] .../v1/dashboard/get

Returns dashboards available to the current user. Use this method to load dashboard headers before assigning dashboards to users, rendering dashboard tabs or requesting widgets with Widget/Get. The response returns Dashboard records with name, period, firm and stock filters, fixed/default flags, creator ownership for the current request user and last update time; id is the filters field, ids as a alias and sort_orders can order the returned list. Access is limited to dashboards created by the current user unless the caller has the dashboard all-select permission; missing body, missing request user context, invalid filters, database errors and permission lookup failures are returned as HTTP 200 ErrorResult business errors. The typical workflow is Dashboard/Get, then Widget/Get for a selected dashboard or Dashboard/Add followed by UserDashboard/Set and Widget/Add.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
sort_orders Array of DashboardSortOrder Optional Sort orders applied to the returned dashboard list.

Filterable Fields

Field Type Description
id int Dashboard IDs. Can be provided through filters.

Sortable Fields

Field
creator.name
id
name

Request Example

{
  "filters": [
    {
      "field": "id",
      "operator": "Equal",
      "value": "3"
    }
  ],
  "sort_orders": [
    {
      "column": "name",
      "direction": "ASC"
    }
  ]
}

Response Parameters

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

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 3,
      "period": "Week",
      "name": "Sales overview",
      "firm_id": 10,
      "stock_id": 4,
      "is_fixed": false,
      "is_default": false,
      "is_creator": true,
      "last_update": 1712345600
    }
  ]
}