Panduan referensi API Claude Enterprise Analytics

Ikhtisar

API Claude Enterprise Analytics memberikan organisasi Anda akses terprogram ke data keterlibatan untuk penggunaan Claude dan Claude Code dalam organisasi Enterprise Anda. Baik Anda membangun dasbor internal untuk aktivitas pengguna atau melacak adopsi proyek, API ini menyediakan metrik agregat yang Anda butuhkan.

Agregasi data

Semua data diagregasi per organisasi, per hari. Setiap endpoint mengembalikan snapshot untuk satu tanggal yang Anda tentukan. Data untuk hari (N-1) dijalankan pada pukul 10:00:00 UTC pada hari N, dan tersedia untuk dipertanyakan tiga hari setelah agregasi, untuk memastikan akurasi data.

Jika data tidak tersedia dalam jangka waktu di atas, ini biasanya menunjukkan kegagalan pipeline data yang perlu diselidiki tim kami secara internal. Kami biasanya menyadari masalah seperti itu, tetapi silakan sampaikan ke CSM Anda jika Anda ingin pemeriksaan akal sehat, atau mencurigai sesuatu yang lain.

Mengaktifkan akses

Untuk membuat kunci API analitik baru, Anda harus menjadi Pemilik Utama dalam organisasi Enterprise Anda. Anda dapat melakukannya dengan menavigasi ke claude.ai/analytics/api-keys.

Beberapa detail lagi yang mungkin membantu:

Anda dapat mengaktifkan/menonaktifkan akses ke API publik kapan saja. Jika Anda menonaktifkan akses dengan mengalihkan sakelar, semua permintaan akan ditolak.
Anda memerlukan kunci dengan cakupan read:analytics untuk mengakses API. Anda dapat membuat beberapa kunci untuk organisasi Anda, tetapi batas laju berlaku di tingkat organisasi , bukan di tingkat kunci . Lihat bagian "Pembatasan laju" di bawah.
Seperti biasa, kami sangat merekomendasikan menangani kunci API dengan aman: jangan pernah bagikan kunci ini secara publik - kunci ini rahasia, dan harus dibagikan dengan aman.

URL Dasar

Semua permintaan dikirim ke:

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

Autentikasi

Setiap permintaan memerlukan kunci API yang diteruskan di header x-api-key. Kunci API Anda harus memiliki cakupan read:analytics. Anda dapat membuat dan mengelola kunci API dari pengaturan admin claude.ai di bagian Kunci API.

Header permintaan contoh:

x-api-key: $YOUR_API_KEY

Paginasi

Beberapa endpoint mengembalikan hasil yang dipaginasi. Paginasi menggunakan pendekatan berbasis kursor, di mana respons mencakup token next_page yang Anda teruskan kembali dalam permintaan berikutnya untuk mengambil halaman hasil berikutnya.

Dua parameter opsional mengontrol paginasi:

limit (integer): Jumlah catatan per halaman. Default ke 20 untuk endpoint /users dan 100 untuk semua endpoint lainnya. Maksimum adalah 1000.

page (string): Token kursor buram dari field next_page respons sebelumnya. Abaikan ini pada permintaan pertama Anda.

Ketika tidak ada lagi hasil, next_page akan null dalam respons.

Respons kesalahan

Semua endpoint mengembalikan kode kesalahan HTTP standar:

Kode	Arti
400	Parameter kueri tidak valid. Penyebab umum termasuk tanggal yang tidak valid, tanggal sebelum 1/1/26 (ketersediaan pertama), atau tanggal yang hari ini atau di masa depan. Ketersediaan data tertunda tiga hari.
404	Kunci API hilang, tidak valid, atau tidak memiliki cakupan `read:analytics`.
429	Batas laju terlampaui. Terlalu banyak permintaan.
503	Kegagalan sementara, silakan coba lagi.

Pembatasan laju

Kami memiliki batas laju default. Jika itu tidak cukup untuk kasus penggunaan Anda, kami ingin memahami alasannya. Jika perlu, kami dapat menyesuaikan batas laju untuk organisasi Anda—silakan hubungi CSM Anda.

Endpoint

1. Daftar aktivitas pengguna

GET /v1/organizations/analytics/users

Mengembalikan metrik keterlibatan per pengguna untuk satu hari. Setiap item dalam respons mewakili satu pengguna dan mencakup jumlah aktivitas mereka di seluruh Claude (chat) dan Claude Code.

Parameter kueri

Bidang	Tipe	Diperlukan	Deskripsi
`date`	string	Ya	Tanggal untuk mengambil metrik, dalam format YYYY-MM-DD.
`limit`	integer	Tidak	Jumlah catatan per halaman (default: 20, maks: 1000).
`page`	string	Tidak	Token kursor dari bidang `next_page` respons sebelumnya untuk mengambil halaman berikutnya.

Bidang respons (per pengguna)

Bidang	Deskripsi
`user.id`	Pengenal unik untuk pengguna.
`user.email_address`	Alamat email pengguna.
`chat_metrics.distinct_conversation_count`	Jumlah percakapan yang berbeda, khususnya dalam Claude.ai.
`chat_metrics.message_count`	Total pesan yang dikirim, khususnya dalam Claude.ai.
`chat_metrics.distinct_projects_created_count`	Jumlah proyek yang dibuat, khususnya dalam Claude.ai.
`chat_metrics.distinct_projects_used_count`	Jumlah proyek yang berbeda digunakan, khususnya dalam Claude.ai.
`chat_metrics.distinct_files_uploaded_count`	Jumlah file yang diunggah, khususnya dalam Claude.ai.
`chat_metrics.distinct_artifacts_created_count`	Jumlah artefak yang dibuat, khususnya dalam Claude.ai.
`chat_metrics.thinking_message_count`	Jumlah pesan pemikiran (diperpanjang), khususnya dalam Claude.ai.
`chat_metrics.distinct_skills_used_count`	Jumlah keterampilan yang berbeda digunakan, khususnya dalam Claude.ai.
`chat_metrics.connectors_used_count`	Jumlah total konektor yang dipanggil, khususnya dalam Claude.ai.
`claude_code_metrics.core_metrics.commit_count`	Jumlah komit git yang dibuat melalui Claude Code.
`claude_code_metrics.core_metrics.pull_request_count`	Jumlah permintaan tarik yang dibuat melalui Claude Code.
`claude_code_metrics.core_metrics.lines_of_code.added_count`	Total baris kode yang ditambahkan.
`claude_code_metrics.core_metrics.lines_of_code.removed_count`	Total baris kode yang dihapus.
`claude_code_metrics.core_metrics.distinct_session_count`	Jumlah sesi Claude Code yang berbeda.
`claude_code_metrics.tool_actions.edit_tool`	Jumlah yang diterima dan ditolak untuk alat Edit.
`claude_code_metrics.tool_actions.multi_edit_tool`	Jumlah yang diterima dan ditolak untuk alat Multi-Edit.
`claude_code_metrics.tool_actions.write_tool`	Jumlah yang diterima dan ditolak untuk alat Write.
`claude_code_metrics.tool_actions.notebook_edit_tool`	Jumlah penerimaan dan penolakan untuk alat Notebook Edit.
`web_search_count`	Total pemanggilan alat pencarian web. Ini berlaku untuk penggunaan claude.ai dan kode Claude dalam organisasi Anda.

Metrik Office Agent (per pengguna)

Setiap catatan pengguna juga menyertakan objek office_metrics dengan rincian per produk untuk Excel dan PowerPoint. Blok ini selalu ada di setiap catatan—organisasi tanpa penggunaan Office Agent melihat nilai nol di semua tempat daripada null.

Objek office_metrics berisi dua kunci: excel dan powerpoint.

Setiap kunci berisi enam bidang yang sama:

Bidang	Deskripsi
`office_metrics.[product].distinct_session_count*`	Jumlah sesi Office Agent yang berbeda.
`office_metrics.[product].message_count`	Jumlah pesan yang dikirim (satu per putaran agen yang selesai).
`office_metrics.[product].skills_used_count`	Total pemanggilan keterampilan. Satu keterampilan yang digunakan lima kali dihitung sebagai lima.
`office_metrics.[product].distinct_skills_used_count`	Jumlah keterampilan yang berbeda digunakan.
`office_metrics.[product].connectors_used_count`	Total pemanggilan konektor. Satu konektor yang digunakan tiga kali dihitung sebagai tiga.
`office_metrics.[product].distinct_connectors_used_count`	Jumlah konektor yang berbeda digunakan.

*Catatan: Di mana [product] adalah salah satu dari excel atau powerpoint.

Contoh permintaan

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. Ringkasan aktivitas

GET /v1/organizations/analytics/summaries

Mengembalikan ringkasan tingkat tinggi tentang keterlibatan dan pemanfaatan tempat duduk per hari untuk organisasi Anda untuk rentang tanggal tertentu. Respons adalah daftar hari dengan jumlah agregat dalam rentang tanggal. Perhatikan bahwa perbedaan maksimum antara ending_date dan starting_date harus 31 hari, dan ada penundaan tiga hari dalam ketersediaan data. Ini berguna untuk melacak pengguna aktif harian, tren mingguan dan bulanan, serta alokasi tempat duduk sekilas.

Kami mendefinisikan "aktif" jika salah satu dari berikut ini benar:

Pengguna mengirim setidaknya satu pesan obrolan di Claude (obrolan).
Pengguna memiliki setidaknya satu sesi Claude Code (lokal atau jarak jauh) yang terkait dengan organisasi C4E, dengan penggunaan alat/aktivitas git

Parameter kueri

Bidang	Tipe	Diperlukan	Deskripsi
`starting_date`	string	Ya	Tanggal mulai untuk mengambil data, dalam format YYYY-MM-DD. Ada penundaan tiga hari dalam ketersediaan data, jadi data terbaru yang dapat Anda akses adalah dari tiga hari yang lalu.
`ending_date`	string	Tidak	Tanggal akhir opsional untuk mengambil data, dalam format YYYY-MM-DD. Ini eksklusif.

Bidang respons

Bidang	Deskripsi
`starting_date`	Hari pertama untuk metrik yang diagregasi, ditafsirkan sebagai tanggal UTC. Ada penundaan tiga hari dalam ketersediaan data, jadi data terbaru yang dapat Anda akses adalah dari tiga hari yang lalu.
`ending_date`	Hari terakhir (eksklusif) untuk metrik yang diagregasi, ditafsirkan sebagai tanggal UTC
`daily_active_user_count`	Jumlah pengguna yang aktif pada tanggal yang ditentukan (berdasarkan konsumsi token).
`weekly_active_user_count`	Jumlah pengguna yang aktif dalam jendela bergulir 7 hari yang berakhir pada tanggal yang ditentukan.
`monthly_active_user_count`	Jumlah pengguna yang aktif dalam jendela bergulir 30 hari yang berakhir pada tanggal yang ditentukan.
`assigned_seat_count`	Jumlah total kursi yang saat ini ditugaskan di organisasi Anda.
`pending_invite_count`	Jumlah undangan yang tertunda dan belum diterima.

Catatan: Jendela bergulir untuk hitungan mingguan dan bulanan melihat ke belakang dari tanggal yang ditentukan (inklusif). Jika data tidak lengkap untuk beberapa hari dalam jendela (misalnya, jika tanggalnya kurang dari 30 hari yang lalu), hitungan bulanan mungkin meremehkan aktivitas.

Contoh permintaan

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

3. Penggunaan proyek Chat

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

Mengembalikan data penggunaan yang dipecah menurut proyek chat untuk tanggal tertentu. Proyek khusus untuk Claude (chat), jadi titik akhir ini berfokus pada permukaan itu. Setiap item menampilkan nama proyek, berapa banyak pengguna unik yang berinteraksi dengannya, dan jumlah total percakapan yang diadakan di proyek itu.

Parameter kueri

Bidang	Tipe	Diperlukan	Deskripsi
`date`	string	Ya	Tanggal untuk mengambil metrik, dalam format YYYY-MM-DD. Ada penundaan tiga hari dalam ketersediaan data, jadi data terbaru yang dapat Anda akses adalah dari tiga hari yang lalu.
`limit`	integer	Tidak	Jumlah catatan per halaman (default: 100, maks: 1000).
`page`	string	Tidak	Token kursor dari bidang `next_page` respons sebelumnya untuk mengambil halaman berikutnya.

Bidang respons (per proyek)

Bidang	Deskripsi
`project_name`	Nama proyek.
`project_id`	ID proyek yang ditandai, yaitu "claude_proj_{ID}"
`distinct_user_count`	Jumlah pengguna unik yang menggunakan proyek ini pada tanggal yang diberikan.
`distinct_conversation_count`	Jumlah percakapan di proyek ini pada tanggal yang diberikan.
`message_count`	Jumlah total pesan yang dikirim dalam proyek ini pada tanggal yang diberikan.
`created_at`	Stempel waktu pembuatan proyek.
`created_by`	`{id, email_address}` pengguna yang membuat proyek.

Contoh permintaan

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. Penggunaan Keterampilan

GET /v1/organizations/analytics/skills

Mengembalikan data penggunaan keterampilan di seluruh Claude (chat) dan Claude Code dalam organisasi Anda untuk tanggal tertentu. Setiap item mewakili keterampilan dan menunjukkan berapa banyak pengguna unik yang menggunakannya.

Parameter kueri

Bidang	Tipe	Diperlukan	Deskripsi
`date`	string	Ya	Tanggal untuk mengambil metrik, dalam format YYYY-MM-DD. Ada penundaan tiga hari dalam ketersediaan data, jadi data terbaru yang dapat Anda akses adalah dari tiga hari yang lalu.
`limit`	integer	Tidak	Jumlah catatan per halaman (default: 100, maks: 1000).
`page`	string	Tidak	Token kursor dari bidang `next_page` respons sebelumnya untuk mengambil halaman berikutnya.

Bidang respons (per keterampilan)

Bidang	Deskripsi
`skill_name`	Nama keterampilan.
`distinct_user_count`	Jumlah pengguna unik yang menggunakan keterampilan ini pada tanggal yang diberikan.
`chat_metrics.distinct_conversation_skill_used_count`	Jumlah percakapan berbeda di mana keterampilan digunakan setidaknya sekali, dalam chat.
`claude_code_metrics.distinct_session_skill_used_count`	Jumlah sesi jarak jauh berbeda di mana keterampilan digunakan setidaknya sekali, dalam Claude Code.

Metrik Office Agent (per keterampilan)

Setiap catatan keterampilan juga mencakup objek office_metrics yang melaporkan berapa banyak sesi Office Agent yang menggunakan keterampilan, dipecah berdasarkan produk. Blok ini selalu ada—organisasi tanpa penggunaan Office Agent melihat semua nilai nol.

Bidang	Deskripsi
`office_metrics.excel.distinct_session_skill_used_count`	Jumlah sesi Office Agent berbeda di Excel di mana keterampilan ini digunakan.
`office_metrics.powerpoint.distinct_session_skill_used_count`	Jumlah sesi Office Agent berbeda di PowerPoint di mana keterampilan ini digunakan.

Contoh permintaan

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

5. Penggunaan Konektor

GET /v1/organizations/analytics/connectors

Mengembalikan data penggunaan MCP/konektor di seluruh Claude (chat) dan Claude Code dalam organisasi Anda untuk tanggal tertentu. Setiap item mewakili konektor dan menunjukkan berapa banyak pengguna unik yang menggunakannya. Nama konektor dinormalisasi dari berbagai sumber — misalnya, "Atlassian MCP server," "mcp-atlassian," dan "atlassian_MCP" semuanya akan muncul sebagai "atlassian."

Parameter kueri

Bidang	Tipe	Diperlukan	Deskripsi
`date`	string	Ya	Tanggal untuk mengambil metrik, dalam format YYYY-MM-DD. Ada penundaan tiga hari dalam ketersediaan data, jadi data terbaru yang dapat Anda akses adalah dari tiga hari yang lalu.
`limit`	integer	Tidak	Jumlah catatan per halaman (default: 100, maks: 1000).
`page`	string	Tidak	Token kursor dari bidang `next_page` respons sebelumnya untuk mengambil halaman berikutnya.

Bidang respons (per konektor)

Bidang	Deskripsi
`connector_name`	Nama konektor yang dinormalisasi.
`distinct_user_count`	Jumlah pengguna unik yang menggunakan konektor ini pada tanggal yang diberikan.
`chat_metrics.distinct_conversation_connector_used_count`	Jumlah percakapan berbeda di mana konektor digunakan setidaknya sekali, dalam obrolan.
`claude_code_metrics.distinct_session_connector_used_count`	Jumlah sesi jarak jauh berbeda di mana keterampilan digunakan setidaknya sekali, dalam Claude Code.

Metrik Office Agent (per konektor)

Setiap catatan konektor juga menyertakan objek office_metrics yang melaporkan berapa banyak sesi Office Agent yang menggunakan konektor, dipecah menurut produk. Blok ini selalu ada—organisasi tanpa penggunaan Office Agent melihat semua nilai nol.

Bidang	Deskripsi
`office_metrics.excel.distinct_session_connector_used_count`	Jumlah sesi Office Agent berbeda di Excel di mana konektor ini digunakan.
`office_metrics.powerpoint.distinct_session_connector_used_count`	Jumlah sesi Office Agent berbeda di PowerPoint di mana konektor ini digunakan.

Contoh permintaan

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