Lewati ke konten utama

Panduan referensi API Claude Enterprise Analytics

Ikhtisar

API Claude Enterprise Analytics memberikan organisasi Anda akses terprogram ke data keterlibatan, adopsi, penggunaan, dan biaya di seluruh permukaan Claude dalam organisasi Enterprise Anda. Baik Anda membangun dasbor internal untuk aktivitas pengguna, melacak adopsi proyek, merekonsiliasi pengeluaran terhadap tagihan bulanan Anda, atau menetapkan batas pengeluaran, API ini menyediakan metrik yang Anda butuhkan.

Agregasi data

Semua data diagregasi per organisasi, per hari. Setiap titik akhir 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 saluran pipa data yang perlu diselidiki tim kami secara internal. Kami biasanya menyadari masalah seperti itu, tetapi silakan sampaikan ini kepada CSM Anda jika Anda ingin pemeriksaan akal sehat, atau mencurigai sesuatu yang lain.

Titik akhir biaya dan penggunaan memiliki model kesegaran yang berbeda. Lihat Titik akhir biaya dan penggunaan di bawah untuk detail.

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 pada tingkat organisasi , bukan 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 - mereka 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.

Contoh header permintaan:

x-api-key: $YOUR_API_KEY

Paginasi

Beberapa titik akhir 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 titik akhir /users dan 100 untuk semua titik akhir lainnya. Untuk titik akhir biaya dan penggunaan, default bervariasi menurut titik akhir dan lebar bucket — lihat Titik akhir biaya dan penggunaan di bawah. Maksimum adalah 1000.

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

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

Penting: Jangan ubah parameter kueri di tengah-tengah urutan pada titik akhir biaya dan penggunaan. Kursor terikat pada filter dan rentang tanggal yang mengeluarkannya. Jika Anda mengubah products[], order_by, group_by[], rentang tanggal, atau filter apa pun dan meneruskan kursor lama, Anda akan mendapatkan kesalahan 400.

Respons kesalahan

Semua titik akhir 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), tanggal yang hari ini atau di masa depan, atau (pada titik akhir biaya dan penggunaan) kursor halaman yang tidak cocok dengan parameter kueri saat ini.

401

Kunci API hilang atau tidak valid (titik akhir biaya dan penggunaan).

404

Kunci API hilang, tidak valid, atau tidak memiliki cakupan read:analytics.

410

Kursor halaman tidak lagi valid. Mulai ulang paginasi dari halaman pertama.

429

Batas laju terlampaui. Terlalu banyak permintaan.

500

Kesalahan internal (titik akhir biaya dan penggunaan).

504

Permintaan habis waktu.

Pembatasan laju

Kami memiliki batas laju default yang berlaku di semua titik akhir dalam API ini. 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.


Titik akhir keterlibatan dan adopsi

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 berbeda 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 berbeda diunggah, khususnya dalam Claude.ai.

chat_metrics.distinct_artifacts_created_count

Jumlah artefak yang berbeda dibuat, khususnya dalam Claude.ai.

chat_metrics.distinct_shared_artifacts_viewed_count

Jumlah artefak bersama yang berbeda dilihat, 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.

chat_metrics.shared_conversations_viewed_count

Jumlah percakapan bersama yang dilihat, 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 penerimaan dan penolakan untuk alat Edit.

claude_code_metrics.tool_actions.multi_edit_tool

Jumlah penerimaan dan penolakan untuk alat Multi-Edit.

claude_code_metrics.tool_actions.write_tool

Jumlah penerimaan dan penolakan 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 mencakup 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 berbeda yang 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 berbeda yang digunakan.

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

Metrik Claude Cowork (per pengguna)

Setiap catatan pengguna juga mencakup objek cowork_metrics dengan keterlibatan Cowork per pengguna. Blok ini selalu ada di setiap catatan—organisasi tanpa penggunaan Cowork melihat nilai nol di semua tempat daripada null.

Bidang

Deskripsi

cowork_metrics.distinct_session_count

Jumlah sesi Cowork yang berbeda.

cowork_metrics.message_count

Total pesan pengguna yang dikirim di Cowork.

cowork_metrics.action_count

Panggilan alat yang berhasil (Bash, Read, Edit, dll.)

cowork_metrics.dispatch_turn_count

Putaran agen yang selesai dalam sesi Dispatch (agen latar belakang).

cowork_metrics.skills_used_count

Total pemanggilan keterampilan. Satu keterampilan yang digunakan lima kali dihitung sebagai lima.

cowork_metrics.distinct_skills_used_count

Jumlah keterampilan yang berbeda digunakan.

cowork_metrics.connectors_used_count

Total invokasi konektor. Satu konektor yang digunakan tiga kali dihitung sebagai tiga.

cowork_metrics.distinct_connectors_used_count

Jumlah konektor yang berbeda digunakan.

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 kursi per hari untuk organisasi Anda untuk rentang tanggal tertentu. Respons adalah daftar hari dengan penghitungan 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 kursi sekilas.

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

  • Pengguna mengirim setidaknya satu pesan obrolan di Claude (chat).

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

  • Pengguna memiliki setidaknya satu sesi Claude Cowork dengan penggunaan alat atau aktivitas pesan.

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, diinterpretasikan 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, diinterpretasikan sebagai tanggal UTC

daily_active_user_count

Jumlah pengguna aktif pada tanggal yang ditentukan (berdasarkan konsumsi token).

weekly_active_user_count

Jumlah pengguna aktif dalam jendela bergulir 7 hari yang berakhir pada tanggal yang ditentukan.

monthly_active_user_count

Jumlah pengguna 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.

cowork_daily_active_user_count

Jumlah pengguna dengan ≥1 sesi Cowork pada hari itu

cowork_weekly_active_user_count

Jumlah pengguna dengan ≥1 sesi Cowork dalam periode bergulir 7 hari.

cowork_monthly_active_user_count

Jumlah pengguna dengan ≥1 sesi Cowork dalam periode bergulir 30 hari.

Catatan: Jendela bergulir untuk penghitungan 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), penghitungan 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

Menampilkan data penggunaan yang dipecah berdasarkan proyek chat untuk tanggal tertentu. Proyek khusus untuk Claude (chat), jadi endpoint ini fokus pada permukaan tersebut. Setiap item menunjukkan nama proyek, berapa banyak pengguna unik yang berinteraksi dengannya, dan jumlah total percakapan yang diadakan di proyek tersebut.

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

Menampilkan 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 obrolan.

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 menurut 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.

Metrik Claude Cowork (per keterampilan)

Setiap catatan keterampilan juga mencakup objek cowork_metrics yang melaporkan berapa banyak sesi Cowork yang menggunakan keterampilan. Blok ini selalu ada—organisasi tanpa penggunaan Cowork melihat semua nilai nol.

cowork_metrics.distinct_session_skill_used_count

Jumlah sesi Cowork berbeda di mana keterampilan ini digunakan setidaknya sekali.

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 (obrolan) 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 field 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 konektor 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 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.

Metrik Claude Cowork (per konektor)

Setiap catatan konektor juga menyertakan objek cowork_metrics yang melaporkan berapa banyak sesi Cowork yang menggunakan konektor. Blok ini selalu ada—organisasi tanpa penggunaan Cowork melihat nilai nol.

Bidang

Deskripsi

cowork_metrics.distinct_session_connector_used_count

Jumlah sesi Cowork berbeda di mana konektor ini digunakan setidaknya sekali.

Contoh permintaan

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


Titik akhir biaya dan penggunaan

Catatan: Titik akhir biaya dan penggunaan berlaku untuk paket Enterprise berbasis penggunaan. Untuk paket Enterprise berbasis kursi, titik akhir ini akan mencerminkan kredit penggunaan saja.

Titik akhir biaya dan penggunaan (tersedia sekarang dalam beta) memberikan organisasi Anda akses terprogram ke data biaya token dan USD untuk Claude (obrolan), Claude Code, Cowork, Office Agent, dan Claude di Chrome.

Ada empat titik akhir dalam dua bentuk:

Bentuk

Titik Akhir

Pengembalian

Per-pengguna (satu baris per pengguna, diurutkan)

user_usage_report, user_cost_report

Pengguna yang diperingkat berdasarkan token atau pengeluaran dalam rentang tanggal.

Diberi ember (satu baris per ember waktu, secara opsional dikelompokkan)

usage_report, cost_report

Penggunaan atau biaya seiring waktu, dipecah menurut produk, model, atau dimensi lainnya.

Gunakan titik akhir per-pengguna untuk menjawab "siapa pengguna dengan pengeluaran terbesar saya?" Gunakan titik akhir diberi ember untuk menjawab "bagaimana tren penggunaan hari ke hari, dipecah menurut produk?"

Kesegaran dan finalitas data

Data biasanya tersedia dalam empat jam setelah penggunaan yang mendasar, tetapi mungkin memerlukan waktu hingga 24 jam. Setiap respons menyertakan stempel waktu data_refreshed_at yang menunjukkan ekspor tempat respons disajikan; penggunaan yang terjadi setelah tanda air itu belum tercermin.

Nilai untuk tanggal tertentu dapat direvisi hingga 30 hari saat acara terlambat tiba dan rekonsiliasi berjalan. Untuk total tingkat faktur, tanggal kueri setidaknya 30 hari di masa lalu.

Ketika ending_at dihilangkan (default adalah "sekarang"), respons akan menyertakan ekor data setelah data_refreshed_at yang tidak lengkap. Untuk hasil stabil di seluruh panggilan berulang, atur ending_at ke nilai pada atau sebelum data_refreshed_at yang dikembalikan sebelumnya.

Batas rentang tanggal

starting_at dapat hingga 365 hari di masa lalu, dan satu kueri dapat mencakup paling banyak 31 hari (ending_at - starting_at). Untuk mencakup periode yang lebih lama, keluarkan beberapa kueri dengan jendela yang berdekatan. Tidak ada data yang tersedia sebelum 2026-01-01.

Paginasi

Keempat titik akhir biaya dan penggunaan dipaginasi dengan kursor buram. Permintaan pertama mengembalikan hingga baris limit ditambah kursor next_page; teruskan kursor itu tanpa perubahan sebagai parameter page pada permintaan berikutnya, dan ulangi hingga has_more adalah false.

Perlakukan next_page sebagai buram: teruskan kembali tanpa perubahan pada permintaan berikutnya dan kirim parameter kueri yang sama di setiap halaman. Jika permintaan mengembalikan 400 atau 410 dengan pesan tentang kursor halaman, buang dan mulai lagi dari halaman pertama.

Jangan ubah parameter kueri di tengah-tengah urutan. Kursor terikat pada filter dan rentang tanggal yang mengeluarkannya. Jika Anda mengubah products[], order_by, group_by[], rentang tanggal, atau filter apa pun dan meneruskan kursor lama, Anda akan mendapatkan kesalahan 400.

Serialisasi parameter daftar

Parameter daftar menggunakan notasi kurung: ulangi nama parameter dengan [] untuk setiap nilai.

products[]=chat&products[]=claude_code

Objek Aktor

Setiap baris hasil per-pengguna mengidentifikasi pengguna yang menghasilkan penggunaan.

{
"type": "user_actor",
"user_id": "user_01AbCdEfGh",
"name": "Jane Smith",
"email": "[email protected]"
}

Bidang

Tipe

Deskripsi

tipe

string

Selalu "user_actor".

user_id

string

ID pengguna. Nilai yang sama diterima oleh user_ids[].

nama

string atau null

Nama pengguna. "Pengguna Terhapus" jika pengguna telah dihapus.

email

string atau null

Alamat email pengguna. Null saat pengguna dihapus.

dihapus

boolean

Benar jika akun telah dihapus.

6. Penggunaan token per-pengguna

GET /v1/organizations/analytics/user_usage_report

Mengembalikan penggunaan token per-pengguna di seluruh rentang tanggal, diurutkan berdasarkan metrik token yang dipilih.

Parameter kueri

Bidang

Tipe

Diperlukan

Default

Deskripsi

starting_at

RFC 3339 datetime

Ya

Awal rentang, inklusif. Dibulatkan ke awal jam dalam UTC. Harus dalam 365 hari terakhir.

ending_at

RFC 3339 datetime

Tidak

sekarang

Akhir rentang, eksklusif. Rentang dapat mencakup paling banyak 31 hari.

products[]

satu atau lebih dari chat, claude_code, cowork, office_agent, claude_in_chrome, claude_design

Tidak

semua produk berbasis kursi

Permukaan produk berbasis kursi saja. Ulangi parameter untuk beberapa nilai.

models[]

string, maks 100 entri

Tidak

semua

Filter ke nama model tertentu (misalnya, claude-opus-4-6, claude-sonnet-4-6, claude-haiku-4-5-20251001).

user_ids[]

string, maks 100 entri

Tidak

semua

Filter ke pengguna tertentu. Berguna untuk mencari set pengguna yang diketahui tanpa melakukan paginasi seluruh organisasi.

context_windows[]

satu atau lebih dari 0-200k, 200k-1M

Tidak

semua

Filter ke tingkat penetapan harga jendela konteks tertentu. Gunakan group_by[]=context_window untuk memecah nilai per tingkat.

inference_geos[]

satu atau lebih dari global, us, not_available

Tidak

semua

Filter ke wilayah inferensi tertentu. not_available cocok dengan baris di mana wilayah tidak diatur. Gunakan group_by[]=inference_geo untuk memecah nilai per wilayah.

speeds[]

satu atau lebih dari fast, standard

Tidak

semua

Filter ke mode inferensi cepat atau standar. Gunakan group_by[]=speed untuk memecah nilai per mode.

group_by[]

satu atau lebih dari product, model, context_window, inference_geo, speed

Tidak

tidak ada

Pisahkan setiap baris pengguna menurut dimensi yang diberikan. Dengan dimensi yang ada, satu pengguna dapat mencakup beberapa baris.

order_by

total_tokens, output_tokens, uncached_input_tokens

Tidak

total_tokens

Metrik untuk diurutkan.

exclude_deleted_users

boolean

Tidak

false

Ketika true, baris untuk pengguna yang dihapus dihilangkan.

order

desc, asc

Tidak

desc

Arah pengurutan.

limit

integer 1–1000

Tidak

20

Baris per halaman.

halaman

string kursor buram

Tidak

Nilai next_page dari respons sebelumnya.

Bidang Respons

Bidang

Deskripsi

organization_id

ID organisasi yang dimiliki kunci API.

data

Array entri, diurutkan berdasarkan order_by dalam arah urutan.

data[].actor

Objek Actor untuk pengguna yang menghasilkan penggunaan.

data[].product

Ketika group_by[] menyertakan produk, permukaan produk. Jika tidak, null.

data[].model

Ketika group_by[] menyertakan model, nama model. Jika tidak, null.

data[].context_window

Ketika group_by[] menyertakan context_window, tingkat konteks (0-200k atau 200k-1M). Jika tidak, null.

data[].inference_geo

Ketika group_by[] menyertakan inference_geo, wilayah inferensi. Jika tidak, null.

data[].speed

Ketika group_by[] menyertakan kecepatan: cepat atau standar. Jika tidak, null.

data[].uncached_input_tokens

Token input yang tidak disajikan dari cache prompt.

data[].cache_creation.ephemeral_5m_input_tokens

Token yang ditulis ke cache prompt 5 menit.

data[].cache_creation.ephemeral_1h_input_tokens

Token yang ditulis ke cache prompt 1 jam.

data[].cache_read_input_tokens

Token input yang disajikan dari cache prompt.

data[].output_tokens

Token output yang dihasilkan.

data[].total_tokens

Jumlah semua komponen token di atas. order_by=total_tokens default mengurutkan pada nilai ini.

data[].server_tool_use.web_search_requests

Jumlah panggilan alat pencarian web.

data[].requests

Jumlah permintaan API

has_more

Apakah halaman lain ada.

next_page

Kursor buram untuk halaman berikutnya; null ketika has_more adalah false.

data_refreshed_at

Stempel waktu ekspor data yang respons ini disajikan dari.

Contoh permintaan

curl "https://api.anthropic.com/v1/organizations/analytics/user_usage_report?starting_at=2026-03-01T00:00:00Z&products[]=claude_code&order_by=output_tokens&limit=20" \

--header "x-api-key: $YOUR_API_KEY"

7. Biaya per pengguna

GET /v1/organizations/analytics/user_cost_report

Mengembalikan biaya USD per pengguna di seluruh rentang tanggal, diurutkan berdasarkan jumlah diskon atau harga daftar.

Parameter kueri

Sama seperti user_usage_report, dengan perbedaan berikut:

Bidang

Tipe

Diperlukan

Default

Deskripsi

order_by

amount, list_amount

Tidak

amount

Metrik untuk diurutkan.

group_by[]

satu atau lebih dari product, model, context_window, inference_geo, speed, cost_type, token_type

Tidak

tidak ada

Pisahkan setiap baris pengguna berdasarkan dimensi yang diberikan. cost_type mengembalikan satu baris per komponen biaya (tokens, web search, code execution); token_type mengembalikan satu baris per jenis token.

Semua parameter lainnya (starting_at, ending_at, products[], models[], user_ids[], order, limit, page) identik.

Bidang respons

Bidang

Deskripsi

organization_id

ID organisasi yang dimiliki kunci API.

data

Array entri, diurutkan berdasarkan order_by dalam arah urutan.

data[].actor

Objek Actor untuk pengguna yang menghasilkan biaya.

data[].product, data[].model, data[].context_window, data[].inference_geo, data[].speed

Ketika nilai group_by[] yang sesuai diatur, nilai dimensi. Jika tidak, null.

data[].currency

Selalu "USD".

data[].amount

Jumlah dalam sen pecahan — biaya konsumsi mentah setelah diskon yang dinegosiasikan. Misalnya, "41280.000000" adalah $412.80. Nilai dijumlahkan di semua produk dalam filter products[].

data[].list_amount

Jumlah harga daftar (pra-diskon) dalam sen pecahan, format yang sama.

data[].cost_type

Ketika group_by[] mencakup cost_type: salah satu dari tokens, web_search, code_execution. null ketika tidak diatur.

data[].token_type

Ketika group_by[] mencakup token_type: salah satu dari uncached_input_tokens, output_tokens, cache_read_input_tokens, cache_creation.ephemeral_5m_input_tokens, cache_creation.ephemeral_1h_input_tokens. Hanya non-null pada baris di mana cost_type adalah tokens.

data[].requests

Jumlah permintaan API

has_more

Apakah halaman lain ada.

next_page

Kursor buram untuk halaman berikutnya.

data_refreshed_at

Stempel waktu ekspor data yang respons ini disajikan dari.

Mengurai jumlah

amount dan list_amount adalah string desimal yang dinyatakan dalam sen. "41280.000000" mewakili 41.280 sen (US $412.80). Untuk mengonversi ke dolar, parse sebagai desimal dan bagi dengan 100. Hindari penguraian floating-point biner untuk nilai yang mungkin melebihi beberapa juta dolar.

Contoh permintaan

curl "https://api.anthropic.com/v1/organizations/analytics/user_cost_report?starting_at=2026-03-01T00:00:00Z&order_by=amount&limit=20" \

--header "x-api-key: $YOUR_API_KEY"

8. Penggunaan token seiring waktu

GET /v1/organizations/analytics/usage_report

Mengembalikan penggunaan token seiring waktu, dikelompokkan per menit, jam, atau hari, secara opsional dipecah berdasarkan produk, model, jendela konteks, wilayah inferensi, atau kecepatan.

Parameter kueri

Bidang

Tipe

Diperlukan

Default

Deskripsi

starting_at

Datetime RFC 3339

Ya

Awal rentang, inklusif. Harus dalam 365 hari terakhir. Dibulatkan ke batas bucket_width terdekat dalam UTC.

ending_at

Datetime RFC 3339

Tidak

sekarang

Akhir rentang, eksklusif. Rentang dapat mencakup paling banyak 31 hari. Dibulatkan ke batas bucket_width terdekat dalam UTC.

bucket_width

1m, 1h, 1d

Tidak

1d

Granularitas bucket waktu: menit, jam, atau hari.

group_by[]

satu atau lebih dari product, model, context_window, inference_geo, speed

Tidak

tidak ada

Dimensi untuk dipecah dalam setiap bucket. Abaikan untuk satu agregat per bucket.

products[]

satu atau lebih dari chat, claude_code, cowork, office_agent, claude_in_chrome, claude_design

Tidak

semua

Filter ke permukaan produk tertentu.

models[]

string, maksimal 100 entri

Tidak

semua

Filter ke nama model tertentu.

context_windows[]

satu atau lebih dari 0-200k, 200k-1M

Tidak

semua

Filter ke tingkat penetapan harga jendela konteks tertentu. Gunakan group_by[]=context_window untuk memecah nilai per tingkat.

inference_geos[]

satu atau lebih dari global, us, not_available

Tidak

semua

Filter ke wilayah inferensi tertentu. not_available cocok dengan baris di mana wilayahnya tidak diatur. Gunakan group_by[]=inference_geo untuk memecah nilai per wilayah.

speeds[]

satu atau lebih dari cepat, standar

Tidak

semua

Filter ke mode inferensi cepat atau standar.

user_ids[]

string, maksimal 100 entri

Tidak

semua

Filter ke pengguna tertentu.

limit

integer

Tidak

bervariasi

Bucket per halaman. Default dan maksimal bervariasi menurut bucket_width: 1d → 7 (maks 31); 1h → 24 (maks 168); 1m → 60 (maks 256).

halaman

string kursor buram

Tidak

Nilai next_page dari respons sebelumnya.

Bidang Respons

Bidang

Deskripsi

organization_id

ID organisasi yang dimiliki kunci API.

data

Array entri, satu per bucket waktu.

data[].starting_at

Awal bucket.

data[].ending_at

Akhir bucket.

data[].results

Array entri, satu per grup dalam bucket. Satu entri dengan semua bidang dimensi null ketika group_by[] dihilangkan.

data[].results[].product, .model, .context_window, .inference_geo, .speed

Ketika nilai group_by[] yang sesuai diatur, nilai dimensi. Jika tidak, null.

data[].results[].uncached_input_tokens

Token input yang tidak dilayani dari cache prompt.

data[].results[].cache_creation.ephemeral_5m_input_tokens

Token ditulis ke cache prompt 5 menit.

data[].results[].cache_creation.ephemeral_1h_input_tokens

Token ditulis ke cache prompt 1 jam.

data[].results[].cache_read_input_tokens

Token input dilayani dari cache prompt.

data[].results[].output_tokens

Token output yang dihasilkan.

data[].results[].server_tool_use.web_search_requests

Jumlah panggilan alat pencarian web.

has_more

Apakah bucket lebih banyak ada.

next_page

Kursor buram untuk halaman berikutnya.

data_refreshed_at

Stempel waktu dari ekspor data yang respons ini disajikan.

Contoh permintaan

--header "x-api-key: $YOUR_API_KEY"

9. Biaya seiring waktu

GET /v1/organizations/analytics/cost_report

Mengembalikan biaya USD seiring waktu, dibagi dan dikelompokkan dengan cara yang sama seperti usage_report.

Parameter kueri

Sama seperti usage_report (bucket_width, group_by[], filters, limit, page). Nilai group_by[] juga menerima cost_type dan token_type di endpoint ini.

Bidang respons

Bidang

Deskripsi

organization_id

ID organisasi yang kunci API milik.

data

Larik entri, satu per bucket waktu.

data[].starting_at

Awal bucket.

data[].ending_at

Akhir bucket.

data[].results

Larik entri, satu per grup dalam bucket.

data[].results[].product, .model, .context_window, .inference_geo, .speed

Ketika nilai group_by[] yang sesuai diatur, nilai dimensi. Jika tidak, null.

data[].results[].cost_type

Ketika group_by[] mencakup cost_type: tokens, web_search, atau code_execution. null ketika tidak diatur.

data[].results[].token_type

Ketika group_by[] mencakup token_type: salah satu dari jenis token yang tercantum di bawah endpoint 7. Hanya endpoint Biaya — token_type ditolak di usage_report.

data[].results[].currency

Selalu "USD".

data[].results[].amount

Jumlah dalam sen pecahan — biaya konsumsi mentah setelah diskon yang dinegosiasikan.

data[].results[].list_amount

Jumlah harga daftar (pra-diskon) dalam sen pecahan.

has_more

Apakah bucket lebih banyak ada.

next_page

Kursor buram untuk halaman berikutnya.

data_refreshed_at

Stempel waktu dari ekspor data yang respons ini disajikan.

Contoh permintaan

curl "https://api.anthropic.com/v1/organizations/analytics/cost_report?starting_at=2026-03-01T00:00:00Z&bucket_width=1d&group_by[]=model" \

--header "x-api-key: $YOUR_API_KEY"
Apakah pertanyaan Anda terjawab?