Skip to main content
POST
/
v1
/
dashboard
/
get-widget-data
Retrieve Widget Data
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/dashboard/get-widget-data \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ScreenTypeId": 1,
  "EntityId": 1001,
  "WidgetTypeId": 5,
  "Filters": [
    {
      "Name": "dateRange",
      "Value": "2023-01-01 to 2023-12-31",
      "Type": "Date"
    }
  ]
}
'
{
  "WidgetDetails": {
    "WidgetTypeId": 5,
    "WidgetName": "Revenue Overview",
    "WidgetConfig": {
      "chartType": "bar",
      "colorTheme": "blue"
    },
    "Categories": [
      1,
      2
    ],
    "Groups": [
      10,
      20
    ]
  },
  "Data": {
    "labels": [
      "Jan",
      "Feb",
      "Mar"
    ],
    "values": [
      12000,
      15000,
      11000
    ],
    "currency": "USD"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

The parameters required to filter and identify the widget data.

The request payload used to fetch data for a specific dashboard widget, including contextual IDs and filters.

ScreenTypeId
integer<int32>

The unique identifier for the screen layout or category where the widget resides.

EntityId
integer<int64> | null

The specific entity ID to scope the data (e.g., a specific Project or Account ID). If null, a global scope is assumed.

WidgetTypeId
integer<int64>

The unique identifier for the specific type of widget being requested.

Filters
object[] | null

An optional list of dynamic filter criteria to refine the widget's data results.

Response

200 - application/json

The widget data was successfully retrieved.

The response object containing both the widget's definition and its calculated data.

WidgetDetails
object

The metadata and configuration details of the widget.

Data
any | null

The actual analytical data content for the widget. The structure of this object varies based on the WidgetTypeId.