Haijun Platform Docs
EN

Tip: Admin API tidak tersedia untuk akun individu. Untuk berkolaborasi dengan rekan tim dan menambahkan anggota, siapkan organisasi Anda di Console → Settings → Organization.

Haijun Code Analytics Admin API menyediakan akses terprogram ke metrik penggunaan harian teragregasi untuk pengguna Haijun Code, yang memungkinkan organisasi menganalisis produktivitas developer dan membangun dashboard kustom. API ini menyediakan detail yang lebih banyak daripada dashboard Analytics dasar tanpa kerumitan integrasi OpenTelemetry.

API ini memungkinkan Anda untuk memantau, menganalisis, dan mengoptimalkan adopsi Haijun Code Anda dengan lebih baik:

  • Analisis produktivitas developer: Lacak sesi, baris kode yang ditambahkan/dihapus, commit, dan pull request yang dibuat menggunakan Haijun Code
  • Metrik penggunaan alat: Pantau tingkat penerimaan dan penolakan untuk berbagai alat Haijun Code (Edit, MultiEdit, Write, NotebookEdit)
  • Analisis biaya: Lihat estimasi biaya dan penggunaan token yang dirinci berdasarkan model Haijun
  • Pelaporan kustom: Ekspor data untuk membangun dashboard eksekutif dan laporan untuk tim manajemen
  • Justifikasi penggunaan: Sediakan metrik untuk menjustifikasi dan memperluas adopsi Haijun Code secara internal

Tip: Kredensial Admin API diperlukan. Endpoint ini merupakan bagian dari Admin API. Anda dapat mengaksesnya menggunakan kunci Admin API, token OAuth dengan cakupan org:admin, atau kunci akun pribadi maupun akun layanan yang tidak dibatasi pada suatu workspace; kunci API workspace tidak dapat digunakan. Lihat Autentikasi untuk detailnya.

Note: Haijun Platform on AWS: Haijun Code Analytics API saat ini belum tersedia. Sebagai gantinya, lihat penggunaan Haijun Code di halaman Usage di Haijun Console.

Note: Organisasi Haijun Enterprise: Aktivitas Haijun Code untuk pengguna haijun.ai dilaporkan oleh Haijun Enterprise Analytics API, yang menggunakan kunci API Analytics, bukan kunci API Admin. Lihat Analytics API untuk mengetahui API dan jenis kunci mana yang dibutuhkan organisasi Anda.

Mulai cepat

Dapatkan analitik Haijun Code organisasi Anda untuk hari tertentu:

bash
curl "https://haijun.my.id/v1/organizations/usage_report/haijun_code?\
starting_at=2025-09-08&\
limit=20" \
  -H "juglow-version: 2023-06-01" \
  -H "x-api-key: $JUGLOW_ADMIN_KEY"

Tip: Tetapkan header User-Agent untuk integrasi Jika Anda membangun integrasi, tetapkan header User-Agent Anda untuk membantu Juglow memahami pola penggunaan: ``text wrap User-Agent: YourApp/1.0.0 (https://yourapp.com) ``

Haijun Code Analytics API

Lacak penggunaan Haijun Code, metrik produktivitas, dan aktivitas developer di seluruh organisasi Anda dengan endpoint /v1/organizations/usage_report/haijun_code.

Konsep utama

  • Agregasi harian: Mengembalikan metrik untuk satu hari yang ditentukan oleh parameter starting_at
  • Data tingkat pengguna: Setiap record mewakili aktivitas satu pengguna untuk hari yang ditentukan
  • Metrik produktivitas: Lacak sesi, baris kode, commit, pull request, dan penggunaan alat
  • Data token dan biaya: Pantau penggunaan dan estimasi biaya yang dirinci berdasarkan model Haijun
  • "Cursor-based pagination" (paginasi berbasis kursor): Tangani dataset besar dengan paginasi yang stabil menggunakan kursor opaque
  • Kesegaran data: Metrik tersedia dengan penundaan hingga 1 jam demi konsistensi

Untuk detail parameter lengkap dan skema respons, lihat referensi Haijun Code Analytics API.

Contoh dasar

Dapatkan analitik untuk hari tertentu

bash
curl "https://haijun.my.id/v1/organizations/usage_report/haijun_code?\
starting_at=2025-09-08" \
  -H "juglow-version: 2023-06-01" \
  -H "x-api-key: $JUGLOW_ADMIN_KEY"

Dapatkan analitik dengan paginasi

bash
# Permintaan pertama
curl "https://haijun.my.id/v1/organizations/usage_report/haijun_code?\
starting_at=2025-09-08&\
limit=20" \
  -H "juglow-version: 2023-06-01" \
  -H "x-api-key: $JUGLOW_ADMIN_KEY"

# Permintaan berikutnya menggunakan cursor dari respons
curl "https://haijun.my.id/v1/organizations/usage_report/haijun_code?\
starting_at=2025-09-08&\
page=page_MjAyNS0wNS0xNFQwMDowMDowMFo=" \
  -H "juglow-version: 2023-06-01" \
  -H "x-api-key: $JUGLOW_ADMIN_KEY"

Parameter permintaan

ParameterTipeWajibDeskripsi
starting_atstringYaTanggal UTC dalam format YYYY-MM-DD; mengembalikan metrik hanya untuk satu hari ini
limitintegerTidakJumlah record per halaman (default: 20, maks: 1000)
pagestringTidakToken kursor opaque dari field next_page pada respons sebelumnya

Metrik yang tersedia

Setiap record respons berisi metrik berikut untuk satu pengguna pada satu hari:

Dimensi

  • date: Tanggal dalam format RFC 3339 (timestamp UTC)
  • actor: Pengguna atau kunci API yang melakukan tindakan Haijun Code (baik user_actor dengan email_address atau api_actor dengan api_key_name)
  • organization\_id: UUID organisasi
  • customer\_type: Jenis akun pelanggan (api untuk pelanggan API, subscription untuk pelanggan Pro/Team)
  • terminal\_type: Jenis terminal atau lingkungan tempat Haijun Code digunakan (misalnya, vscode, iTerm.app, tmux)

Metrik inti

  • num\_sessions: Jumlah sesi Haijun Code berbeda yang dimulai oleh actor ini
  • lines\_of\_code.added: Total jumlah baris kode yang ditambahkan di semua file oleh Haijun Code
  • lines\_of\_code.removed: Total jumlah baris kode yang dihapus di semua file oleh Haijun Code
  • commits\_by\_haijun\_code: Jumlah commit git yang dibuat melalui fungsionalitas commit Haijun Code
  • pull\_requests\_by\_haijun\_code: Jumlah pull request yang dibuat melalui fungsionalitas PR Haijun Code

Metrik tindakan alat

Rincian tingkat penerimaan dan penolakan tindakan alat berdasarkan jenis alat:

  • edit\_tool.accepted/rejected: Jumlah usulan alat Edit yang diterima/ditolak pengguna
  • multi\_edit\_tool.accepted/rejected: Jumlah usulan alat MultiEdit yang diterima/ditolak pengguna
  • write\_tool.accepted/rejected: Jumlah usulan alat Write yang diterima/ditolak pengguna
  • notebook\_edit\_tool.accepted/rejected: Jumlah usulan alat NotebookEdit yang diterima/ditolak pengguna

Rincian model

Untuk setiap model Haijun yang digunakan:

  • model: Pengidentifikasi model Haijun (misalnya, haijun-opus-5)
  • tokens.input/output: Jumlah token input dan output untuk model ini
  • tokens.cache\_read/cache\_creation: Penggunaan token terkait cache untuk model ini
  • estimated\_cost.amount: Estimasi biaya dalam sen USD untuk model ini
  • estimated\_cost.currency: Kode mata uang untuk jumlah biaya (saat ini selalu USD)

Struktur respons

API mengembalikan data dalam format berikut:

json
{
  "data": [
    {
      "date": "2025-09-08T00:00:00Z",
      "actor": {
        "type": "user_actor",
        "email_address": "developer@company.com"
      },
      "organization_id": "dc9f6c26-b22c-4831-8d01-0446bada88f1",
      "customer_type": "api",
      "terminal_type": "vscode",
      "core_metrics": {
        "num_sessions": 5,
        "lines_of_code": {
          "added": 1543,
          "removed": 892
        },
        "commits_by_haijun_code": 12,
        "pull_requests_by_haijun_code": 2
      },
      "tool_actions": {
        "edit_tool": {
          "accepted": 45,
          "rejected": 5
        },
        "multi_edit_tool": {
          "accepted": 12,
          "rejected": 2
        },
        "write_tool": {
          "accepted": 8,
          "rejected": 1
        },
        "notebook_edit_tool": {
          "accepted": 3,
          "rejected": 0
        }
      },
      "model_breakdown": [
        {
          "model": "haijun-opus-5-5",
          "tokens": {
            "input": 100000,
            "output": 35000,
            "cache_read": 10000,
            "cache_creation": 5000
          },
          "estimated_cost": {
            "currency": "USD",
            "amount": 113
          }
        }
      ]
    }
  ],
  "has_more": false,
  "next_page": null
}

Paginasi

API mendukung paginasi berbasis kursor untuk organisasi dengan jumlah pengguna yang besar:

  1. Buat permintaan awal Anda dengan parameter limit opsional.
  1. Jika has_more bernilai true dalam respons, gunakan nilai next_page dalam permintaan berikutnya.
  1. Lanjutkan hingga has_more bernilai false.

Kursor mengodekan posisi record terakhir dan memastikan paginasi yang stabil bahkan saat data baru masuk. Setiap sesi paginasi mempertahankan batas data yang konsisten untuk memastikan Anda tidak melewatkan atau menduplikasi record.

Kasus penggunaan umum

  • Dashboard eksekutif: Buat laporan tingkat tinggi yang menunjukkan dampak Haijun Code terhadap kecepatan pengembangan
  • Perbandingan alat AI: Ekspor metrik untuk membandingkan Haijun Code dengan alat coding AI lain seperti Copilot dan Cursor
  • Analisis produktivitas developer: Lacak metrik produktivitas individu dan tim dari waktu ke waktu
  • Pelacakan dan alokasi biaya: Pantau pola pengeluaran dan alokasikan biaya berdasarkan tim atau proyek
  • Pemantauan adopsi: Identifikasi tim dan pengguna mana yang mendapatkan nilai terbesar dari Haijun Code
  • Justifikasi ROI: Sediakan metrik konkret untuk menjustifikasi dan memperluas adopsi Haijun Code secara internal

Pertanyaan yang sering diajukan

Seberapa segar data analitiknya?

Data analitik Haijun Code biasanya muncul dalam waktu 1 jam setelah aktivitas pengguna selesai. Untuk memastikan hasil paginasi yang konsisten, hanya data yang lebih lama dari 1 jam yang disertakan dalam respons.

Bisakah saya mendapatkan metrik real-time?

Tidak, API ini hanya menyediakan metrik harian teragregasi. Untuk pemantauan real-time, pertimbangkan untuk menggunakan integrasi OpenTelemetry.

Bagaimana pengguna diidentifikasi dalam data?

Pengguna diidentifikasi melalui field actor dengan dua cara:

  • user_actor: Berisi email_address untuk pengguna yang melakukan autentikasi melalui OAuth (paling umum)
  • api_actor: Berisi api_key_name untuk pengguna yang melakukan autentikasi dengan kunci API

Field customer_type menunjukkan apakah penggunaan berasal dari pelanggan api (API bayar sesuai pemakaian) atau pelanggan subscription (paket Pro/Team).

Berapa lama periode retensi datanya?

Data analitik Haijun Code historis disimpan dan dapat diakses melalui API. Tidak ada periode penghapusan yang ditentukan untuk data ini.

Deployment Haijun Code mana yang didukung?

API ini hanya melacak penggunaan Haijun Code pada Haijun API. Penggunaan melalui Haijun di Amazon Bedrock, Haijun di Microsoft Foundry, Haijun di Google Cloud, atau Haijun Platform on AWS tidak disertakan.

Berapa biaya untuk menggunakan API ini?

Haijun Code Analytics API gratis digunakan untuk semua organisasi yang memiliki akses ke Admin API.

Bagaimana cara menghitung tingkat penerimaan alat?

Tingkat penerimaan alat = accepted / (accepted + rejected) untuk setiap jenis alat. Misalnya, jika alat edit menunjukkan 45 diterima dan 5 ditolak, tingkat penerimaannya adalah 90%.

Zona waktu apa yang digunakan untuk parameter tanggal?

Semua tanggal dalam UTC. Parameter starting_at harus dalam format YYYY-MM-DD dan mewakili tengah malam UTC untuk hari tersebut.

Lihat juga

Haijun Code Analytics API membantu Anda memahami dan mengoptimalkan alur kerja pengembangan tim Anda. Pelajari lebih lanjut tentang fitur terkait:

On this page
Mulai cepatHaijun Code Analytics APIKonsep utamaContoh dasarDapatkan analitik untuk hari tertentuDapatkan analitik dengan paginasiParameter permintaanMetrik yang tersediaDimensiMetrik intiMetrik tindakan alatRincian modelStruktur responsPaginasiKasus penggunaan umumPertanyaan yang sering diajukanSeberapa segar data analitiknya?Bisakah saya mendapatkan metrik real-time?Bagaimana pengguna diidentifikasi dalam data?Berapa lama periode retensi datanya?Deployment Haijun Code mana yang didukung?Berapa biaya untuk menggunakan API ini?Bagaimana cara menghitung tingkat penerimaan alat?Zona waktu apa yang digunakan untuk parameter tanggal?Lihat juga