К основному содержимому

Справочное руководство API Claude Enterprise Analytics

Обновлено на этой неделе

Обзор

API Claude Enterprise Analytics предоставляет вашей организации программный доступ к данным взаимодействия для использования Claude и Claude Code в рамках вашей корпоративной организации. Независимо от того, создаёте ли вы внутренние панели мониторинга активности пользователей или отслеживаете внедрение проектов, этот API предоставляет агрегированные метрики, которые вам нужны.

Агрегация данных

Все данные агрегируются по организации, в день. Каждая конечная точка возвращает снимок для одной указанной даты. Данные за день (N-1) обрабатываются в 10:00:00 UTC в день N и доступны для запроса через три дня после агрегации для обеспечения точности данных.

Если данные недоступны в указанный выше период, это обычно указывает на сбой конвейера данных, который нашей команде потребуется исследовать внутри. Мы обычно осведомлены о таких проблемах, но пожалуйста, обратитесь к своему CSM, если вы хотите проверить или подозреваете что-то ещё.

Включение доступа

Чтобы создать новые ключи API аналитики, вы должны быть основным владельцем в вашей корпоративной организации. Вы можете сделать это, перейдя на claude.ai/analytics/api-keys.

Вот некоторые дополнительные детали, которые могут быть полезны:

  • Вы можете включить/отключить доступ к общедоступному API в любое время. Если вы отключите доступ, переключив переключатель, все запросы будут отклонены.

  • Вам потребуется ключ с областью read:analytics для доступа к API. Вы можете создать несколько ключей для вашей организации, но ограничения скорости применяются на уровне организации, а не на уровне ключа. См. раздел «Ограничение скорости» ниже.

  • Как всегда, мы настоятельно рекомендуем безопасно обрабатывать ключи API: никогда не делитесь этими ключами публично — они являются секретными и должны быть переданы безопасно.

Базовый URL

Все запросы отправляются на:

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

Аутентификация

Каждый запрос требует ключ API, переданный в заголовке x-api-key. Ваш ключ API должен иметь область read:analytics. Вы можете создавать и управлять ключами API из параметров администратора claude.ai в разделе «Ключи API».

Пример заголовков запроса:

x-api-key: $YOUR_API_KEY

Разбиение на страницы

Несколько конечных точек возвращают результаты с разбиением на страницы. Разбиение на страницы использует подход на основе курсора, где ответ включает токен next_page, который вы передаёте обратно в следующем запросе для получения следующей страницы результатов.

Два необязательных параметра управляют разбиением на страницы:

limit (целое число): количество записей на странице. По умолчанию 20 для конечной точки /users и 100 для всех остальных конечных точек. Максимум — 1000.

page (строка): непрозрачный токен курсора из поля next_page предыдущего ответа. Пропустите это в вашем первом запросе.

Когда больше нет результатов, next_page будет null в ответе.

Ответы об ошибках

Все конечные точки возвращают стандартные коды ошибок HTTP:

Код

Значение

400

Параметр запроса недействителен. Частые причины включают недействительную дату, дату до 1/1/26 (первая доступность) или дату, которая является сегодняшней или будущей. Доступность данных задерживается на три дня.

404

Ключ API отсутствует, недействителен или не имеет области read:analytics.

429

Превышен лимит скорости. Слишком много запросов.

503

Временный сбой, пожалуйста, повторите попытку.

Ограничение скорости

У нас есть ограничения скорости по умолчанию. Если этого недостаточно для вашего варианта использования, нам бы хотелось понять почему. При необходимости мы можем отрегулировать ограничения скорости для вашей организации — пожалуйста, свяжитесь с вашим CSM.


Конечные точки

1. Список активности пользователей

GET /v1/organizations/analytics/users

Возвращает метрики взаимодействия для каждого пользователя за один день. Каждый элемент в ответе представляет одного пользователя и включает количество его действий в Claude (чат) и Claude Code.

Параметры запроса

Поле

Тип

Требуется

Описание

date

строка

Да

Дата для получения метрик в формате YYYY-MM-DD.

limit

целое число

Нет

Количество записей на странице (по умолчанию: 20, максимум: 1000).

page

строка

Нет

Токен курсора из поля next_page предыдущего ответа для получения следующей страницы.

Поля ответа (на пользователя)

Поле

Описание

user.id

Уникальный идентификатор пользователя.

user.email_address

Адрес электронной почты пользователя.

chat_metrics.distinct_conversation_count

Количество отдельных диалогов, в частности в Claude.ai.

chat_metrics.message_count

Всего отправленных сообщений, в частности в Claude.ai.

chat_metrics.distinct_projects_created_count

Количество созданных проектов, в частности в Claude.ai.

chat_metrics.distinct_projects_used_count

Количество использованных отдельных проектов, в частности в Claude.ai.

chat_metrics.distinct_files_uploaded_count

Количество загруженных файлов, в частности в Claude.ai.

chat_metrics.distinct_artifacts_created_count

Количество созданных артефактов, в частности в Claude.ai.

chat_metrics.thinking_message_count

Количество сообщений с расширенным размышлением, в частности в Claude.ai.

chat_metrics.distinct_skills_used_count

Количество использованных отдельных навыков, в частности в Claude.ai.

chat_metrics.connectors_used_count

Общее количество вызванных соединителей, в частности в Claude.ai.

claude_code_metrics.core_metrics.commit_count

Количество коммитов git, выполненных через Claude Code.

claude_code_metrics.core_metrics.pull_request_count

Количество запросов на слияние, созданных через Claude Code.

claude_code_metrics.core_metrics.lines_of_code.added_count

Всего добавленных строк кода.

claude_code_metrics.core_metrics.lines_of_code.removed_count

Всего удаленных строк кода.

claude_code_metrics.core_metrics.distinct_session_count

Количество отдельных сеансов Claude Code.

claude_code_metrics.tool_actions.edit_tool

Количество принятых и отклоненных действий инструмента Edit.

claude_code_metrics.tool_actions.multi_edit_tool

Количество принятых и отклоненных действий инструмента Multi-Edit.

claude_code_metrics.tool_actions.write_tool

Количество принятых и отклоненных действий инструмента Write.

claude_code_metrics.tool_actions.notebook_edit_tool

Количество принятых и отклоненных операций для инструмента редактирования Notebook.

web_search_count

Общее количество вызовов инструмента веб-поиска. Это применяется как к claude.ai, так и к использованию Claude Code в вашей организации.

Метрики Office Agent (на пользователя)

Каждая запись пользователя также включает объект office_metrics с разбивкой по продуктам для Excel и PowerPoint. Этот блок всегда присутствует в каждой записи — организации без использования Office Agent видят нулевые значения вместо null.

Объект office_metrics содержит два ключа: excel и powerpoint.

Каждый ключ содержит одинаковые шесть полей:

Поле

Описание

office_metrics.[product].distinct_session_count*

Количество отдельных сеансов Office Agent.

office_metrics.[product].message_count

Количество отправленных сообщений (по одному за каждый завершенный ход агента).

office_metrics.[product].skills_used_count

Общее количество вызовов навыков. Один навык, использованный пять раз, считается пятью.

office_metrics.[product].distinct_skills_used_count

Количество различных использованных навыков.

office_metrics.[product].connectors_used_count

Общее количество вызовов соединителей. Один соединитель, использованный три раза, считается тремя.

office_metrics.[product].distinct_connectors_used_count

Количество различных использованных соединителей.

*Примечание: Где [product] — это один из excel или powerpoint.

Пример запроса

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. Сводка активности

GET /v1/organizations/analytics/summaries

Возвращает высокоуровневую сводку вовлеченности и использования лицензий в день для вашей организации за заданный диапазон дат. Ответ представляет собой список дней с агрегированными подсчетами в диапазоне дат. Обратите внимание, что максимальная разница между ending_date и starting_date должна быть 31 день, и существует трехдневная задержка в доступности данных. Это полезно для отслеживания ежедневно активных пользователей, еженедельных и ежемесячных тенденций и распределения лицензий с первого взгляда.

Мы определяем "активного" пользователя, если верно одно из следующего:

  • Пользователь отправил хотя бы одно сообщение в чате Claude (chat).

  • Пользователь имел хотя бы один сеанс Claude Code (локальный или удаленный), связанный с организацией C4E, с использованием инструментов/активностью git

Параметры запроса

Поле

Тип

Обязательно

Описание

starting_date

строка

Да

Начальная дата для получения данных в формате YYYY-MM-DD. Существует трехдневная задержка в доступности данных, поэтому самые свежие данные, к которым вы можете получить доступ, относятся к трем дням назад.

ending_date

строка

Нет

Дополнительная конечная дата для получения данных в формате YYYY-MM-DD. Это исключающее значение.

Поля ответа

Поле

Описание

starting_date

Первый день, за который агрегированы метрики, интерпретируется как дата UTC. Существует трехдневная задержка в доступности данных, поэтому самые свежие данные, к которым вы можете получить доступ, относятся к трем дням назад.

ending_date

Последний день (исключающее значение), за который агрегированы метрики, интерпретируется как дата UTC

daily_active_user_count

Количество пользователей, активных в указанную дату (на основе потребления токенов).

weekly_active_user_count

Количество пользователей, активных в течение 7-дневного скользящего окна, заканчивающегося в указанную дату.

monthly_active_user_count

Количество пользователей, активных в течение 30-дневного скользящего окна, заканчивающегося в указанную дату.

assigned_seat_count

Общее количество мест, в настоящее время назначенных в вашей организации.

pending_invite_count

Количество ожидающих приглашений, которые еще не были приняты.

Примечание: Скользящие окна для еженедельного и ежемесячного подсчета смотрят в прошлое от указанной даты (включительно). Если данные неполные за некоторые дни в окне (например, если дата менее 30 дней в прошлом), ежемесячный подсчет может недоучитывать активность.

Пример запроса

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

3. Использование проекта Chat

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

Возвращает данные об использовании, разбитые по проектам чата для указанной даты. Проекты специфичны для Claude (чат), поэтому этот эндпоинт сосредоточен на этой поверхности. Каждый элемент показывает имя проекта, количество уникальных пользователей, которые с ним взаимодействовали, и общее количество разговоров в этом проекте.

Параметры запроса

Поле

Тип

Обязательно

Описание

date

строка

Да

Дата для получения метрик в формате YYYY-MM-DD. Существует трехдневная задержка в доступности данных, поэтому самые свежие данные, к которым вы можете получить доступ, относятся к трем дням назад.

limit

целое число

Нет

Количество записей на странице (по умолчанию: 100, максимум: 1000).

page

строка

Нет

Токен курсора из поля next_page предыдущего ответа для получения следующей страницы.

Поля ответа (на проект)

Поле

Описание

project_name

Имя проекта.

project_id

Идентификатор проекта с тегом, т.е. "claude_proj_{ID}"

distinct_user_count

Количество уникальных пользователей, которые использовали этот проект в указанную дату.

distinct_conversation_count

Количество разговоров в этом проекте в указанную дату.

message_count

Общее количество сообщений, отправленных в этом проекте в указанную дату.

created_at

Временная метка создания проекта.

created_by

{id, email_address} пользователя, который создал проект.

Пример запроса

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. Использование навыков

GET /v1/organizations/analytics/skills

Возвращает данные об использовании навыков в Claude (чат) и Claude Code в вашей организации за указанную дату. Каждый элемент представляет навык и показывает, сколько уникальных пользователей его использовали.

Параметры запроса

Поле

Тип

Обязательно

Описание

date

строка

Да

Дата для получения метрик в формате YYYY-MM-DD. Данные доступны с задержкой в три дня, поэтому самые свежие данные, которые вы можете получить, относятся к трём дням назад.

limit

целое число

Нет

Количество записей на странице (по умолчанию: 100, максимум: 1000).

page

строка

Нет

Токен курсора из поля next_page предыдущего ответа для получения следующей страницы.

Поля ответа (для каждого навыка)

Поле

Описание

skill_name

Название навыка.

distinct_user_count

Количество уникальных пользователей, которые использовали этот навык в указанную дату.

chat_metrics.distinct_conversation_skill_used_count

Количество отдельных диалогов, в которых навык был использован хотя бы один раз в чате.

claude_code_metrics.distinct_session_skill_used_count

Количество отдельных удалённых сеансов, в которых навык был использован хотя бы один раз в Claude Code.

Метрики Office Agent (для каждого навыка)

Каждая запись навыка также включает объект office_metrics, который сообщает, сколько сеансов Office Agent использовали навык, разбитых по продуктам. Этот блок всегда присутствует — организации без использования Office Agent видят все нулевые значения.

Поле

Описание

office_metrics.excel.distinct_session_skill_used_count

Количество отдельных сеансов Office Agent в Excel, в которых был использован этот навык.

office_metrics.powerpoint.distinct_session_skill_used_count

Количество отдельных сеансов Office Agent в PowerPoint, в которых был использован этот навык.

Пример запроса

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

5. Использование соединителей

GET /v1/organizations/analytics/connectors

Возвращает данные об использовании MCP/соединителей в Claude (чат) и Claude Code в вашей организации за указанную дату. Каждый элемент представляет соединитель и показывает, сколько уникальных пользователей его использовали. Названия соединителей нормализованы из различных источников — например, «Atlassian MCP server», «mcp-atlassian» и «atlassian_MCP» будут отображаться как «atlassian».

Параметры запроса

Поле

Тип

Обязательно

Описание

date

строка

Да

Дата для получения метрик в формате YYYY-MM-DD. Данные доступны с задержкой в три дня, поэтому самые свежие данные, которые вы можете получить, относятся к трём дням назад.

limit

целое число

Нет

Количество записей на странице (по умолчанию: 100, максимум: 1000).

page

строка

Нет

Токен курсора из поля next_page предыдущего ответа для получения следующей страницы.

Поля ответа (для каждого соединителя)

Поле

Описание

connector_name

Нормализованное имя соединителя.

distinct_user_count

Количество уникальных пользователей, которые использовали этот соединитель в указанную дату.

chat_metrics.distinct_conversation_connector_used_count

Количество отдельных диалогов, в которых соединитель был использован хотя бы один раз в чате.

claude_code_metrics.distinct_session_connector_used_count

Количество отдельных удалённых сеансов, в которых навык был использован хотя бы один раз в Claude Code.

Метрики Office Agent (для каждого соединителя)

Каждая запись соединителя также включает объект office_metrics, который сообщает, сколько сеансов Office Agent использовали соединитель, разбитых по продуктам. Этот блок всегда присутствует — организации без использования Office Agent видят все нулевые значения.

Поле

Описание

office_metrics.excel.distinct_session_connector_used_count

Количество отдельных сеансов Office Agent в Excel, в которых был использован этот соединитель.

office_metrics.powerpoint.distinct_session_connector_used_count

Количество отдельных сеансов Office Agent в PowerPoint, в которых был использован этот соединитель.

Пример запроса

curl -X GET "https://api.anthropic.com/v1/organizations/analytics/connectors?date=2025-01-01"
--header "x-api-key: $YOUR_API_KEY"
Нашли ответ на свой вопрос?