Buscar en la documentación

Resumen

Widgets del dashboard, sus cifras y el diseño de cada persona.

4 endpointsGET · 2PUT · 1DELETE · 1
GET/dashboardDiseño de la persona: alcance (general o personal), si lo personalizó y cada widget con sus topes, su lugar y si está visible

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)

Respuesta 200

CampoTipo
dataobjeto
data.scope"general" | "personal"
data.customizedsí/no
data.columnsentero
data.widgetslista de objeto
{
  "data": {
    "scope": "general",
    "customized": true,
    "columns": 1,
    "widgets": [
      "texto"
    ]
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
GET/dashboard/metricsDatos de los widgets pedidos. trend_days admite 7, 30 o 90. meta.generated_at dice cuándo se calculó el dato más antiguo

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)

Parámetros

NombreDóndeTipoObligatorio
widgets[]Consultalista de objetoNo
trend_daysConsulta"7" | "30" | "90"No

Respuesta 200

CampoTipo
datatexto
metaobjeto
meta.generated_attexto
{
  "data": "texto",
  "meta": {
    "generated_at": "2026-11-01T14:30:00Z"
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
PUT/dashboard/layoutGuarda el diseño completo: widgets: [{code, x, y, w, h, visible}]

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
Content-Typeapplication/jsonCuerpo en JSON
X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio

Cuerpo

CampoTipoObligatorio
widgetslista de objetoSí
widgets[].code"operation_pulse" | "risk_map" | "status_flow" | "backlog_balance" | "total_incidents" | "pending_incidents" | "overdue_incidents" | "unassigned_incidents" | "incidents_by_status" | "incidents_by_priority" | "created_vs_resolved" | "due_soon" | "assigned_to_me" | "workload_by_agent"Sí
widgets[].xentero · ≥ 0 · ≤ 11Sí
widgets[].yentero · ≥ 0 · ≤ 200Sí
widgets[].wentero · ≥ 1 · ≤ 12Sí
widgets[].hentero · ≥ 1 · ≤ 50Sí
widgets[].visiblesí/noSí
{
  "widgets": [
    {
      "code": "operation_pulse",
      "x": 0,
      "y": 0,
      "w": 1,
      "h": 1,
      "visible": true
    }
  ]
}

Respuesta 200

CampoTipo
dataobjeto
data.scope"general" | "personal"
data.customizedsí/no
data.columnsentero
data.widgetslista de objeto
{
  "data": {
    "scope": "general",
    "customized": true,
    "columns": 1,
    "widgets": [
      "texto"
    ]
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)
  • 422Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca
DELETE/dashboard/layoutVuelve al diseño original (borra lo guardado)

Cabeceras de la petición

CabeceraValorPara qué
AuthorizationBearer trazo_…Token de sesión que entrega el ingreso
Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio

Respuesta 200

CampoTipo
dataobjeto
data.scope"general" | "personal"
data.customizedsí/no
data.columnsentero
data.widgetslista de objeto
{
  "data": {
    "scope": "general",
    "customized": true,
    "columns": 1,
    "widgets": [
      "texto"
    ]
  }
}
Cabecera de la respuestaPara qué
X-Request-IdIdentificador de la petición; es el trace_id de los errores

Errores posibles

  • 401Sin sesión o la sesión expiró (UNAUTHENTICATED)

Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API.

Ver el módulo en la biblioteca