[POST] .../v1/widgetdata/get
Returns data for one widget. Use this method after Widget/Get to load the live data payload for a selected dashboard widget. The response shape depends on the widget type: built-in widgets return the corresponding WidgetDataType model, while Integration widgets return validated chart JSON from the connected integration or an empty chart-compatible object when the integration response is unavailable or invalid. The request body is required and id must be a positive widget id; the method loads the widget, its dashboard filters, optional widget filters, the dashboard period and cached data where supported before returning the widget-specific result. The current implementation does not perform a separate permission check in this action, so callers should pass widget ids obtained through the dashboard assignment workflow. Business errors such as missing body, invalid id, missing widget or dashboard, unsupported widget type, connected integration lookup failures, disabled or unsupported integration handler, database errors and cache/data 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 |
|---|---|---|
| id | int | Record ID. |
Request Example
{
"filters": [
{
"Field": "id",
"Operator": "Equal",
"Value": "15"
}
]
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Object | Result object. |
Response Example
{
"ok": true,
"result": {
"total_amount": 1250000.50,
"average_receipt_amount": 85000.00,
"receipt_count": 32,
"sales_amount": 1250000.50,
"sales_count": 32,
"sales_pos_count": 3,
"sales_unit_count": 84,
"refund_amount": 25000.00,
"refund_count": 1,
"refund_pos_count": 1,
"refund_unit_count": 2,
"gross_profit": 420000.25,
"sales_amount_per_square_meter": 31000.75,
"operating_cash_avg_down_time": 12.5,
"operating_cash_avg_work_time": 430.0,
"markup_avg_in_percent": 33.6
}
}