Saltar al contenido principal
GET
Tool health
Este reporte responde una pregunta concreta: ¿las herramientas de mis agentes siguen funcionando? No mira cómo está configurada cada herramienta, sino qué pasó de verdad cuando el agente la usó con leads reales. Sirve para detectar a tiempo una integración que dejó de responder, como una credencial vencida o una búsqueda que nunca encuentra nada, antes de que lo noten tus clientes. Devuelve una fila por herramienta, tarea y canal, con las herramientas con problemas primero.

Antes de empezar

  • Las llaves MCP necesitan workflows:read y también leads:read, porque los ejemplos incluyen datos de leads. Las llaves REST de acceso completo no necesitan nada más.
  • tools no cuenta los leads de prueba, los leads sandbox ni las conversaciones del Playground. Agrega include_test=true para verlos por separado, en test_tools.
  • Es solo de lectura: consultarlo no ejecuta ninguna herramienta.
  • Los errores devuelven un código estable en error, por ejemplo invalid_days. Asocia cada código a tus propios textos.

Qué consultar

Pruebas antes de salir en live

Con include_test=true, la respuesta agrega test_tools: las mismas filas, con los mismos campos y el mismo orden, armadas solo con conversaciones del Playground y leads de prueba y sandbox. tools sigue contando solo leads reales, así que las pruebas nunca se mezclan con el tráfico real. Sin el parámetro, o con false, test_tools no viene en la respuesta. Úsalo para revisar las herramientas de una tarea mientras la pruebas en el Playground, antes de que lleguen leads reales. Los demás parámetros se aplican a ambas listas. Las ejecuciones de Probar Workflow Tool no se cuentan, porque no ocurren en una conversación.

Qué significa cada número

Cómo interpretar los resultados

Límites

  • Hasta 100 filas en tools y 100 en test_tools. Si hay más coincidencias en cualquiera de las dos listas, truncated viene en true.
  • Cada consulta lee primero la actividad más reciente. Con include_test=true, la actividad de prueba se lee en la misma consulta. Si el período tuvo más actividad de herramientas de la que cabe en una consulta, truncated viene en true y window.scanned_from indica desde qué momento parten los conteos. Acota con workflow_id, tool_name, channel o menos days.
  • args y result se cortan en 600 caracteres. Las llaves de API, tokens, contraseñas y firmas aparecen enmascarados. Los datos del lead, como nombres y teléfonos, no se eliminan: trata los ejemplos como datos de leads.

Autorizaciones

X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_. To work inside a sub-account with a main account key, also send the optional X-Nexor-Sub-Account-Id header.

Parámetros de consulta

days
integer
predeterminado:7

How many days back to read, counted in 24-hour periods from the moment of the request. Any other value returns 400 invalid_days.

Rango requerido: 1 <= x <= 14
workflow_id
string<uuid>

Task ID (workflow in the API). Counts only that task's conversations and calls. A malformed ID returns 400 invalid_workflow_id; a task from another account returns an empty tools list.

tool_name
string

Exact tool name. Surrounding spaces are ignored. Empty after trimming, or longer than 120 characters, returns 400 invalid_tool_name.

Maximum string length: 120
channel
enum<string>

Only runs on this channel. call is phone calls; unsupervised-whatsapp is a personal WhatsApp line. Any other value returns 400 invalid_channel.

Opciones disponibles:
whatsapp,
unsupervised-whatsapp,
instagram,
messenger,
webchat,
sms,
imessage,
email,
call
only_problems
boolean
predeterminado:false

true keeps only tools where failed + empty is at least half of the runs that reached the integration (calls - blocked), with at least 3 such runs. Accepts true, false, 1, or 0; anything else returns 400 invalid_only_problems.

include_test
boolean
predeterminado:false

true adds test_tools: the same rows built only from Playground conversations and test and sandbox leads. tools keeps counting real leads only. Accepts true, false, 1, or 0; anything else returns 400 invalid_include_test.

Respuesta

Tool rows, sorted by problem rate ((failed + empty) / (calls - blocked)) and then by calls, highest first.

success
boolean
requerido
window
object
requerido
tools
object[]
requerido
Maximum array length: 100
truncated
boolean
requerido

true when more than 100 rows matched in tools or in test_tools, or when the window had more activity than one request reads (see window.scanned_from). Narrow with workflow_id, tool_name, channel, or fewer days.

test_tools
object[]

Present only when include_test is true. Same item shape and order as tools, built only from Playground conversations and test and sandbox leads, so tests before going live do not mix with real traffic. Calls to Test a workflow tool are not included.

Maximum array length: 100
Última modificación el 2 de octubre de 2026