---
title: "Retrieve Widget Data"
method: POST
path: "/v1/dashboard/get-widget-data"
tags: ["Report"]
---

# Retrieve Widget Data

`POST /v1/dashboard/get-widget-data`

Fetches analytical data for a specific dashboard widget based on the provided filters and widget ID.

## Request body

- WidgetRequestDto — The request payload used to fetch data for a specific dashboard widget, including contextual IDs and filters.
  - `ScreenTypeId` integer — The unique identifier for the screen layout or category where the widget resides.
  - `EntityId` integer, nullable — 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 — The unique identifier for the specific type of widget being requested.
  - `Filters` WidgetFilterDto[], nullable — An optional list of dynamic filter criteria to refine the widget's data results.
    - `Name` string, nullable — The unique identifier or name of the filter (e.g., 'startDate').
    - `Value` string, nullable — The specific value to be applied for this filter criterion.
    - `Type` string, nullable — The data type or category of the filter value.

## Response `200`

The widget data was successfully retrieved.

- WidgetDataResponseDto — The response object containing both the widget's definition and its calculated data.
  - `WidgetDetails` WidgetResponseDto — Data transfer object representing the details of a dashboard widget.
    - `WidgetTypeId` integer — The unique identifier for the type of widget.
    - `WidgetName` string, nullable — The display name of the widget.
    - `WidgetConfig` unknown
    - `Categories` integer[], nullable — A list of group IDs that have permission to view or manage this widget.
    - `Groups` integer[], nullable
  - `Data` unknown

---

[API](https://skmtc.net/nayax/apis/nayax-cortina-api.md) · [All operations](https://skmtc.net/nayax/apis/nayax-cortina-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nayax/nayax-cortina-api/revisions/421f6f83c257/schema)