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

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

Обновлено сегодня

Обзор

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

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

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

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

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

Чтобы создать новые ключи API аналитики, вы должны быть основным владельцем (Primary Owner) в вашей Enterprise организации. Вы можете сделать это, перейдя на 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 Edit.

web_search_count

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

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

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 (чат).

  • Пользователь имел хотя бы один сеанс 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. Использование проектов чата

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

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

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

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 в вашей организации за заданную дату. Каждый элемент представляет навык и показывает, сколько уникальных пользователей его использовали.

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

Поле

Тип

Обязательно

Нашли ответ на свой вопрос?