Crear un nuevo widget

Entorno prueba

https://test.your-api-server.com

POST

/api/dashboards/{dashboardId}/widgets

Widgets

Última modificación:2026-03-30 00:53:56

Crea un widget con configuración personalizada según su tipo.

Modos de Tópico MQTT:

AUTO: Sistema genera tópico único (miobox/{dashboardId}/{widgetId})

CUSTOM: Usuario proporciona tópico personalizado

PLC: Selecciona tag PLC con configuración MQTT incluida

Tipos de Widget Disponibles:

KPI: Indicador de rendimiento con icono y formato numérico

Gauge: Medidor con umbrales de color

Line Chart: Gráfico de líneas para series temporales

Bar Chart: Gráfico de barras para comparaciones

Pie Chart: Gráfico circular para distribuciones

Table: Tabla de datos con columnas configurables

Area Chart: Gráfico de área para tendencias

Donut Chart: Gráfico de dona

Radar Chart: Gráfico de radar para comparaciones multidimensionales

Text: Visualización de texto/mensajes

Solicitud

Autorización

JWT Bearer

Agregar el parámetro

Authorization

a Encabezados

Ejemplo:

Authorization: ********************

Parámetros de ruta

Parámetros del Body application/jsonRequerido

Ejemplos

Respuestas

🟢201

application/json

Widget creado exitosamente

Body

🟠400

🟠401

🟠404

🔴500

Ejemplo de Solicitud

Shell

JavaScript

Java

Swift

cURL

KPI - Indicador de RendimientoGauge - Medidor con UmbralesLine Chart - Serie TemporalBar Chart - Comparación por CategoríasTable - Tabla de DatosMultiple Topics - Comparación Multi-SensorPLC Tag Mode - Desde Tag Configurado

curl --location --request POST 'https://test.your-api-server.com/api/dashboards/507f1f77bcf86cd799439011/widgets' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Producción Total",
    "type": "kpi",
    "description": "Unidades producidas en tiempo real",
    "config": {
        "title": "Unidades Producidas",
        "dataSource": "mqtt",
        "useAutoTopic": false,
        "mqttTopic": "nodered/produccion/total",
        "icon": "trending-up",
        "prefix": "",
        "suffix": " units",
        "decimals": 0,
        "animated": true,
        "showSparkline": true,
        "dataExtraction": {
            "type": "single-value",
            "valuePath": "count",
            "correctionFactor": 1
        }
    }
}'

Ejemplo de Respuesta

{
    "msg": "Widget creado exitosamente",
    "widget": {
        "_id": "string",
        "dashboardId": "string",
        "name": "string",
        "type": "line-chart",
        "description": "string",
        "config": {
            "title": "string",
            "dataSource": "mqtt",
            "topicMode": "auto",
            "useAutoTopic": true,
            "autoGeneratedTopic": "miobox/507f1f77bcf86cd799439011/607f1f77bcf86cd799439012",
            "mqttTopic": "nodered/produccion/linea1",
            "selectedPlcTag": {},
            "useMultipleTopics": false,
            "mqttTopics": [
                {
                    "topic": "string",
                    "label": "string",
                    "color": "string"
                }
            ],
            "mqttBroker": {
                "host": "string",
                "port": 0,
                "protocol": "ws",
                "username": "string",
                "password": "string",
                "useCustomBroker": true
            },
            "dataExtraction": {
                "type": "single-value",
                "valuePath": "value",
                "expectedFields": [
                    "string"
                ],
                "correctionFactor": 1,
                "timestampPath": "string",
                "categoryPath": "string",
                "aggregation": "none",
                "keepHistory": 50
            },
            "showLegend": true,
            "showGrid": true,
            "colors": [
                "string"
            ],
            "icon": "string",
            "prefix": "string",
            "suffix": "string",
            "decimals": 0,
            "thresholds": [
                {
                    "max": 0,
                    "color": "string"
                }
            ],
            "columns": [
                {
                    "field": "string",
                    "label": "string",
                    "width": "string",
                    "sortable": true
                }
            ]
        },
        "metadata": {
            "lastDataReceived": "2019-08-24T14:15:22.123Z",
            "lastError": "string",
            "messageCount": 0,
            "connectionStatus": "connected"
        },
        "status": true,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    }
}

Modificado en 2026-03-30 00:53:56

Obtener todos los widgets de un dashboard

Obtener un widget por ID