Ir al contenido principal

Guía de referencia de la API de Claude Enterprise Analytics

Actualizado esta semana

Descripción general

La API de Claude Enterprise Analytics proporciona a tu organización acceso programático a datos de participación para el uso de Claude y Claude Code dentro de tu organización Enterprise. Ya sea que estés creando paneles internos para la actividad de usuarios o rastreando la adopción de proyectos, esta API proporciona las métricas agregadas que necesitas.

Agregación de datos

Todos los datos se agregan por organización, por día. Cada endpoint devuelve una instantánea para una fecha única que especifiques. Los datos del día (N-1) se ejecutan a las 10:00:00 UTC en el día N, y están disponibles para consultas tres días después de la agregación, para garantizar la precisión de los datos.

Si los datos no están disponibles dentro del plazo anterior, esto generalmente indica una falla en la canalización de datos que nuestro equipo necesitará investigar internamente. Generalmente somos conscientes de tales problemas, pero comunícalo a tu CSM si deseas una verificación o si sospechas algo más.

Habilitación del acceso

Para crear nuevas claves de API de análisis, debes ser Propietario Principal dentro de tu organización Enterprise. Puedes hacerlo navegando a claude.ai/analytics/api-keys.

Aquí hay algunos detalles más que podrían ser útiles:

  • Puedes habilitar/deshabilitar el acceso a la API pública en cualquier momento. Si deshabilitas el acceso desactivando el interruptor, se denegarán todas las solicitudes.

  • Necesitarás una clave con el alcance read:analytics para acceder a la API. Puedes crear múltiples claves para tu organización, pero los límites de velocidad se aplican a nivel de organización, no a nivel de clave. Consulta la sección "Limitación de velocidad" a continuación.

  • Como siempre, recomendamos encarecidamente manejar las claves de API de forma segura: nunca compartas estas claves públicamente - son secretas y deben compartirse de forma segura.

URL base

Todas las solicitudes se envían a:

https://api.anthropic.com/v1/organizations/analytics/

Autenticación

Cada solicitud requiere una clave de API pasada en el encabezado x-api-key. Tu clave de API debe tener el alcance read:analytics. Puedes crear y administrar claves de API desde la configuración de administrador de claude.ai en la sección Claves de API.

Encabezados de solicitud de ejemplo:

x-api-key: $YOUR_API_KEY

Paginación

Varios endpoints devuelven resultados paginados. La paginación utiliza un enfoque basado en cursores, donde la respuesta incluye un token next_page que pasas en tu siguiente solicitud para recuperar la siguiente página de resultados.

Dos parámetros opcionales controlan la paginación:

limit (entero): Número de registros por página. Por defecto es 20 para el endpoint /users y 100 para todos los demás endpoints. El máximo es 1000.

page (cadena): El token de cursor opaco del campo next_page de la respuesta anterior. Omite esto en tu primera solicitud.

Cuando no hay más resultados, next_page será null en la respuesta.

Respuestas de error

Todos los endpoints devuelven códigos de error HTTP estándar:

Código

Significado

400

Un parámetro de consulta es inválido. Las causas comunes incluyen una fecha inválida, una fecha anterior a 1/1/26 (primera disponibilidad) o una fecha que es hoy o en el futuro. La disponibilidad de datos se retrasa tres días.

404

La clave de API falta, es inválida o no tiene el alcance read:analytics.

429

Límite de velocidad excedido. Demasiadas solicitudes.

503

Falla transitoria, por favor reintentar.

Limitación de velocidad

Tenemos límites de velocidad predeterminados. Si eso no es suficiente para tu caso de uso, nos encantaría entender por qué. Si es necesario, podemos ajustar los límites de velocidad para tu organización—comunícate con tu CSM.


Endpoints

1. Listar actividad de usuario

GET /v1/organizations/analytics/users

Devuelve métricas de participación por usuario para un único día. Cada elemento en la respuesta representa un usuario e incluye sus conteos de actividad en Claude (chat) y Claude Code.

Parámetros de consulta

Campo

Tipo

Requerido

Descripción

date

cadena

La fecha para la que se deben recuperar las métricas, en formato YYYY-MM-DD.

limit

entero

No

Número de registros por página (predeterminado: 20, máximo: 1000).

page

cadena

No

Token de cursor de la respuesta anterior next_page para recuperar la siguiente página.

Campos de respuesta (por usuario)

Campo

Descripción

user.id

Identificador único del usuario.

user.email_address

La dirección de correo electrónico del usuario.

chat_metrics.distinct_conversation_count

Número de conversaciones distintas, específicamente dentro de Claude.ai.

chat_metrics.message_count

Total de mensajes enviados, específicamente dentro de Claude.ai.

chat_metrics.distinct_projects_created_count

Número de proyectos creados, específicamente dentro de Claude.ai.

chat_metrics.distinct_projects_used_count

Número de proyectos distintos utilizados, específicamente dentro de Claude.ai.

chat_metrics.distinct_files_uploaded_count

Número de archivos cargados, específicamente dentro de Claude.ai.

chat_metrics.distinct_artifacts_created_count

Número de artefactos creados, específicamente dentro de Claude.ai.

chat_metrics.thinking_message_count

Número de mensajes de pensamiento (extendidos), específicamente dentro de Claude.ai.

chat_metrics.distinct_skills_used_count

Número de habilidades distintas utilizadas, específicamente dentro de Claude.ai.

chat_metrics.connectors_used_count

Número total de conectores invocados, específicamente dentro de Claude.ai.

claude_code_metrics.core_metrics.commit_count

Número de confirmaciones de git realizadas a través de Claude Code.

claude_code_metrics.core_metrics.pull_request_count

Número de solicitudes de extracción creadas a través de Claude Code.

claude_code_metrics.core_metrics.lines_of_code.added_count

Total de líneas de código agregadas.

claude_code_metrics.core_metrics.lines_of_code.removed_count

Total de líneas de código eliminadas.

claude_code_metrics.core_metrics.distinct_session_count

Número de sesiones distintas de Claude Code.

claude_code_metrics.tool_actions.edit_tool

Recuentos aceptados y rechazados para la herramienta Editar.

claude_code_metrics.tool_actions.multi_edit_tool

Recuentos aceptados y rechazados para la herramienta Multi-Editar.

claude_code_metrics.tool_actions.write_tool

Recuentos aceptados y rechazados para la herramienta Escribir.

claude_code_metrics.tool_actions.notebook_edit_tool

Recuentos aceptados y rechazados para la herramienta Notebook Edit.

web_search_count

Total de invocaciones de la herramienta de búsqueda web. Esto se aplica tanto a claude.ai como al uso de código Claude dentro de su organización.

Métricas del Agente de Office (por usuario)

Métricas del Agente de Office (por usuario)

El objeto office_metrics contiene dos claves: excel y powerpoint.

Cada clave contiene los mismos seis campos:

Campo

Descripción

office_metrics.[product].distinct_session_count*

Número de sesiones distintas del Agente de Office.

office_metrics.[product].message_count

Número de mensajes enviados (uno por turno de agente completado).

office_metrics.[product].skills_used_count

Total de invocaciones de habilidades. Una única habilidad utilizada cinco veces cuenta como cinco.

office_metrics.[product].distinct_skills_used_count

Número de habilidades distintas utilizadas.

office_metrics.[product].connectors_used_count

Total de invocaciones de conectores. Un único conector utilizado tres veces cuenta como tres.

office_metrics.[product].distinct_connectors_used_count

Número de conectores distintos utilizados.

*Nota: Donde [product] es uno de excel o powerpoint.

Solicitud de ejemplo

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/users?date=2025-01-01&limit=3"
--header "x-api-key: $YOUR_API_KEY"

2. Resumen de actividad

GET /v1/organizations/analytics/summaries

Devuelve un resumen de alto nivel del compromiso y la utilización de asientos por día para su organización en un rango de fechas determinado. La respuesta es una lista de días con recuentos agregados dentro del rango de fechas. Tenga en cuenta que la diferencia máxima entre ending_date y starting_date debe ser 31 días, y hay un retraso de tres días en la disponibilidad de datos. Esto es útil para rastrear usuarios activos diarios, tendencias semanales y mensuales, y asignación de asientos de un vistazo.

Definimos "activo" si alguno de los siguientes es verdadero:

  • El usuario envió al menos un mensaje de chat en Claude (chat).

  • El usuario tuvo al menos una sesión de Claude Code (local o remota) asociada con la organización C4E, con uso de herramientas/actividad de git

Parámetros de consulta

Campo

Tipo

Requerido

Descripción

starting_date

cadena

La fecha de inicio para recuperar datos, en formato YYYY-MM-DD. Hay un retraso de tres días en la disponibilidad de datos, por lo que los datos más recientes a los que puede acceder son de hace tres días.

ending_date

cadena

No

La fecha de finalización opcional para recuperar datos, en formato YYYY-MM-DD. Esto es exclusivo.

Campos de respuesta

Campo

Descripción

starting_date

Primer día para el cual se agregan las métricas, interpretado como una fecha UTC. Hay un retraso de tres días en la disponibilidad de datos, por lo que los datos más recientes a los que puede acceder son de hace tres días.

ending_date

Último día (exclusivo) para el cual se agregan las métricas, interpretado como una fecha UTC

daily_active_user_count

Número de usuarios activos en la fecha especificada (basado en el consumo de tokens).

weekly_active_user_count

Número de usuarios activos dentro de la ventana móvil de 7 días que termina en la fecha especificada.

monthly_active_user_count

Número de usuarios activos dentro de la ventana móvil de 30 días que termina en la fecha especificada.

assigned_seat_count

Número total de asientos actualmente asignados en tu organización.

pending_invite_count

Número de invitaciones pendientes que aún no han sido aceptadas.

Nota: Las ventanas móviles para los recuentos semanales y mensuales miran hacia atrás desde la fecha especificada (inclusive). Si los datos están incompletos para algunos días dentro de la ventana (por ejemplo, si la fecha es menos de 30 días en el pasado), el recuento mensual puede subestimar la actividad.

Solicitud de ejemplo

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/summaries?starting_date=2025-01-01"
--header "x-api-key: $YOUR_API_KEY"

3. Uso del proyecto de Chat

GET /v1/organizations/analytics/apps/chat/projects

Devuelve datos de uso desglosados por proyecto de chat para una fecha determinada. Los proyectos son específicos de Claude (chat), por lo que este endpoint se enfoca en esa superficie. Cada elemento muestra el nombre del proyecto, cuántos usuarios únicos interactuaron con él y el número total de conversaciones realizadas en ese proyecto.

Parámetros de consulta

Campo

Tipo

Requerido

Descripción

date

string

La fecha para recuperar métricas, en formato YYYY-MM-DD. Hay un retraso de tres días en la disponibilidad de datos, por lo que los datos más recientes a los que puedes acceder son de hace tres días.

limit

integer

No

Número de registros por página (predeterminado: 100, máximo: 1000).

page

string

No

Token de cursor de la respuesta anterior's next_page campo para recuperar la siguiente página.

Campos de respuesta (por proyecto)

Campo

Descripción

project_name

El nombre del proyecto.

project_id

El id del proyecto etiquetado, es decir, "claude_proj_{ID}"

distinct_user_count

Número de usuarios únicos que utilizaron este proyecto en la fecha especificada.

distinct_conversation_count

Número de conversaciones en este proyecto en la fecha especificada.

message_count

Número total de mensajes enviados dentro de este proyecto en la fecha especificada.

created_at

La marca de tiempo de creación del proyecto.

created_by

{id, email_address} del usuario que creó el proyecto.

Solicitud de ejemplo

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects?date=2025-01-01&limit=50"
--header "x-api-key: $YOUR_API_KEY"

4. Uso de habilidades

GET /v1/organizations/analytics/skills

Devuelve datos de uso de habilidades en Claude (chat) y Claude Code dentro de tu organización para una fecha determinada. Cada elemento representa una habilidad y muestra cuántos usuarios únicos la utilizaron.

Parámetros de consulta

Campo

Tipo

Requerido

Descripción

date

string

La fecha para recuperar métricas, en formato YYYY-MM-DD. Hay un retraso de tres días en la disponibilidad de datos, por lo que los datos más recientes a los que puedes acceder son de hace tres días.

limit

integer

No

Número de registros por página (predeterminado: 100, máximo: 1000).

page

string

No

Token de cursor de la respuesta anterior's next_page para recuperar la siguiente página.

Campos de respuesta (por habilidad)

Campo

Descripción

skill_name

El nombre de la habilidad.

distinct_user_count

Número de usuarios únicos que utilizaron esta habilidad en la fecha determinada.

chat_metrics.distinct_conversation_skill_used_count

Número de conversaciones distintas en las que se utilizó la habilidad al menos una vez, en chat.

claude_code_metrics.distinct_session_skill_used_count

Número de sesiones remotas distintas en las que se utilizó la habilidad al menos una vez, en Claude Code.

Métricas del Agente de Office (por habilidad)

Cada registro de habilidad también incluye un objeto office_metrics que informa cuántas sesiones del Agente de Office utilizaron la habilidad, desglosadas por producto. Este bloque siempre está presente: las organizaciones sin uso del Agente de Office ven valores de cero.

Campo

Descripción

office_metrics.excel.distinct_session_skill_used_count

Número de sesiones distintas del Agente de Office en Excel en las que se utilizó esta habilidad.

office_metrics.powerpoint.distinct_session_skill_used_count

Número de sesiones distintas del Agente de Office en PowerPoint en las que se utilizó esta habilidad.

Solicitud de ejemplo

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/skills?date=2025-01-01"
--header "x-api-key: $YOUR_API_KEY"

5. Uso de conectores

GET /v1/organizations/analytics/connectors

Devuelve datos de uso de MCP/conectores en Claude (chat) y Claude Code dentro de tu organización para una fecha determinada. Cada elemento representa un conector y muestra cuántos usuarios únicos lo utilizaron. Los nombres de conectores se normalizan desde varias fuentes: por ejemplo, "Atlassian MCP server," "mcp-atlassian," y "atlassian_MCP" aparecerían todos como "atlassian."

Parámetros de consulta

Campo

Tipo

Requerido

Descripción

date

string

La fecha para la que se deben recuperar las métricas, en formato YYYY-MM-DD. Hay un retraso de tres días en la disponibilidad de datos, por lo que los datos más recientes a los que puede acceder son de hace tres días.

limit

entero

No

Número de registros por página (predeterminado: 100, máximo: 1000).

page

cadena

No

Token de cursor de la respuesta anterior's next_page para recuperar la siguiente página.

Campos de respuesta (por conector)

Campo

Descripción

connector_name

El nombre normalizado del conector.

distinct_user_count

Número de usuarios únicos que utilizaron este conector en la fecha especificada.

chat_metrics.distinct_conversation_connector_used_count

Número de conversaciones distintas en las que se utilizó el conector al menos una vez, en chat.

claude_code_metrics.distinct_session_connector_used_count

Número de sesiones remotas distintas en las que se utilizó la habilidad al menos una vez, en Claude Code.

Métricas de Office Agent (por conector)

Cada registro de conector también incluye un objeto office_metrics que informa cuántas sesiones de Office Agent utilizaron el conector, desglosado por producto. Este bloque siempre está presente: las organizaciones sin uso de Office Agent ven todos los valores en cero.

Campo

Descripción

office_metrics.excel.distinct_session_connector_used_count

Número de sesiones distintas de Office Agent en Excel en las que se utilizó este conector.

office_metrics.powerpoint.distinct_session_connector_used_count

Número de sesiones distintas de Office Agent en PowerPoint en las que se utilizó este conector.

Ejemplo de solicitud

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/connectors?date=2025-01-01"
--header "x-api-key: $YOUR_API_KEY"
¿Ha quedado contestada tu pregunta?