Skip to main content
GET
Obtener analítica de llamadas a herramientas del agente
Este es un endpoint v2 que usa autenticación mediante Token Bearer y parámetros de consulta, a diferencia de la API de Analítica v1, que usa claves de servicio en el cuerpo de la solicitud. Consulta Autenticación más abajo.
Este endpoint no está pensado para monitorizar el consumo en tiempo real. El límite de solicitudes es bajo (10 solicitudes por hora por equipo). Úsalo para informes periódicos y exportaciones masivas.

Autenticación

Este endpoint usa autenticación mediante Token Bearer. Incluye tu token en el encabezado Authorization:
Usa una clave de API de usuario de servicio de Devin con el permiso Usar API de Analítica Local o una clave de servicio de Windsurf con el permiso Analytics Read. Consulta Autenticación para saber cómo crear cada una. A diferencia de la fuente de datos cascade_tool_usage de la v1, este endpoint acepta claves de API de usuario de servicio de Devin, por lo que los equipos de la plataforma de Cognition pueden obtener informes sobre el uso de herramientas sin necesidad de una clave de servicio de Windsurf.

Métricas

El parámetro de consulta metric es obligatorio y actualmente solo acepta calls, el número de llamadas a herramientas que ha realizado el agente. Aparece como un campo entero calls en cada fila. Las solicitudes que omiten metric o especifican otra métrica fallan con un error 400. Las llamadas a herramientas se contabilizan cuando el agente invoca una herramienta en Devin Desktop o en la Devin CLI (incluida la CLI cuando se ejecuta como agente dentro de otros editores), con cualquier modelo. El parámetro product también es obligatorio y actualmente solo acepta agent.

Herramientas

Agrupa por tool para desglosar las llamadas por categoría de herramienta. Así, cada fila incluye un campo tool con uno de los siguientes valores: No todas las categorías se aplican a todos los clientes: LIST_DIRECTORY, MEMORY, PROPOSE_CODE, PROXY_WEB_SERVER, DEPLOY_WEB_APP y MQUERY se registran para el agente de Devin Desktop, mientras que las nuevas herramientas de Devin CLI que aún no tienen una categoría asignada se contabilizan en OTHER.

Agrupación y granularidad

Usa granularity y group_by para controlar la forma de los datos devueltos:
  • Sin granularidad ni agrupación: devuelve una única fila agregada para todo el intervalo de fechas
  • granularity=daily: cada fila incluye un timestamp en formato YYYY-MM-DD
  • granularity=monthly: cada fila incluye un timestamp en formato YYYY-MM
  • group_by=tool: cada fila incluye un tool (consulta Herramientas más arriba)
  • group_by=user: cada fila incluye un user_id, además de un user_email si hay uno registrado para ese usuario
  • group_by=model_uid: cada fila incluye un model_uid
  • group_by=ide: cada fila incluye un ide
  • group_by=ide,ide_version: cada fila incluye ide e ide_version (para agrupar por ide_version también hay que incluir ide)
  • group_by=os: cada fila incluye un os, como darwin (macOS), windows o linux
Las dimensiones se pueden combinar; por ejemplo, group_by=user,tool muestra con qué frecuencia cada usuario ha invocado cada herramienta. Las dimensiones session y source de Get Output no se admiten aquí. Se aplican los mismos filtros models, group_id y user_id que en Get Consumption, además de un filtro tool que limita el recuento a una sola categoría de herramienta (por ejemplo, tool=SEARCH_WEB). Solo este endpoint acepta tool; si se pasa a cualquier otro endpoint de la API de analítica v2, se devuelve un error 400.

Ejemplo

Contar las búsquedas web por usuario durante una semana:
Cada fila muestra el recuento de SEARCH_WEB de un usuario. Si prefieres ver todas las categorías por usuario, quita el filtro tool y agrega group_by=user,tool.

Paginación

Los resultados se paginan con un tamaño de página predeterminado de 1000 filas (máximo 10 000). Cuando hay más resultados disponibles, la respuesta incluye un next_page_cursor en el objeto pagination. Pásalo como parámetro de consulta page_cursor en una solicitud que repita los mismos parámetros de consulta originales. Los cursores están vinculados al endpoint que los emitió; un cursor de /consumption o /output se rechaza con un 400. Los cursores de paginación caducan a las 24 horas. Las solicitudes de páginas posteriores no cuentan como nuevas consultas para tu límite de solicitudes.

Límites de solicitudes

Este endpoint tiene un límite de solicitudes de 10 solicitudes por hora por equipo. Si superas este límite, el servidor devuelve 429 Too Many Requests con un encabezado Retry-After. Paginar una consulta anterior (siguiendo un next_page_cursor) no cuenta para este límite; solo cuenta la consulta inicial de cada informe. El límite es bajo porque este endpoint está pensado para informes periódicos, no para la monitorización del consumo en tiempo real.

Autorizaciones

Authorization
string
header
requerido

Una clave de servicio con el permiso Analytics Read, pasada como token Bearer en el encabezado Authorization.

Crea una clave de servicio en tu configuración del equipo, en la sección "Service Keys".

Parámetros de consulta

metric
string
requerido

Métrica que se devolverá; aparece como un campo en cada fila. Métricas admitidas:

  • calls — número de llamadas a herramientas realizadas por el agente
start_date
string<date>
requerido

Inicio del rango de fechas (incluido) en formato YYYY-MM-DD.

end_date
string<date>
requerido

Fin del rango de fechas (incluido) en formato YYYY-MM-DD. El rango no debe superar los 90 días.

product
enum<string>
requerido

Producto cuyas llamadas a herramientas se consultarán.

Opciones disponibles:
agent
granularity
enum<string>

Granularidad temporal para agrupar los resultados. Cuando se especifica, cada fila incluye un campo timestamp. Si se omite, los resultados se agregan para todo el rango de fechas.

Opciones disponibles:
daily,
monthly
group_by
string

Lista de dimensiones separadas por comas por las que agrupar los resultados. Dimensiones admitidas:

  • tool — incluye tool en cada fila (la categoría de herramienta, como SEARCH_WEB o RUN_COMMAND)
  • user — incluye user_id en cada fila, además de user_email si el usuario tiene un correo electrónico registrado
  • model_uid — incluye model_uid en cada fila
  • ide — incluye ide en cada fila
  • ide_version — incluye ide_version en cada fila; requiere que también se incluya ide
  • os — incluye os en cada fila
models
string

Lista de UID de modelos separados por comas por los que filtrar los resultados.

tool
string

Restringe el recuento a una categoría de herramienta, como SEARCH_WEB o RUN_COMMAND (coincidencia exacta). Solo se admite en este endpoint.

group_id
string

Filtra los resultados para incluir solo a los usuarios de un grupo específico. La clave de servicio debe tener acceso a este grupo. No se admite con claves de API de usuario de servicio de Devin.

user_id
string

Filtra los resultados por un usuario específico (UID de autenticación).

page_size
integer
predeterminado:1000

Número máximo de filas que se devolverán por página.

Rango requerido: 1 <= x <= 10000
page_cursor
string

Cursor opaco obtenido de pagination.next_page_cursor en una respuesta anterior para obtener la página siguiente. Envía el mismo valor de metric que en la solicitud que generó el cursor; se rechazan los cursores generados por otros endpoints.

Respuesta

Datos de llamadas a herramientas devueltos correctamente.

data
object[]
requerido

Array de filas con datos de llamadas a herramientas.

pagination
object
requerido
metadata
object
requerido