Skip to main content
GET
/
v1
/
dashboard
/
widgets
Get Available Widgets
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/dashboard/widgets \
  --header 'Authorization: <api-key>'
[
  {
    "WidgetTypeId": 101,
    "WidgetName": "Sales Summary",
    "WidgetConfig": {
      "defaultView": "monthly",
      "showLegend": true
    },
    "Categories": [
      1,
      5
    ],
    "Groups": [
      100
    ]
  },
  {
    "WidgetTypeId": 102,
    "WidgetName": "Active Users",
    "WidgetConfig": {
      "refreshInterval": 300
    },
    "Categories": [
      2
    ],
    "Groups": [
      100,
      101
    ]
  }
]

Authorizations

Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Query Parameters

screenTypeId
integer<int32>

The unique identifier of the screen type to filter the widgets.

Response

200 - application/json

A list of widgets was successfully retrieved.

WidgetTypeId
integer<int64>

The unique identifier for the type of widget.

WidgetName
string | null

The display name of the widget.

WidgetConfig
any | null

A JSON object containing specific configuration settings for the widget UI.

Categories
integer<int32>[] | null

A list of group IDs that have permission to view or manage this widget.

Groups
integer<int32>[] | null