Lihat analitik

GET/v1/reports/analyticsJalankan

Membutuhkan izin payments:read.

Parameter query

fromstringwajib

Hari pertama periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-01

Pola: ^\d{4}-\d{2}-\d{2}$

tostringwajib

Hari terakhir periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-26

Pola: ^\d{4}-\d{2}-\d{2}$

breakdown_bystringopsional

Cara memecah angka: none (satu total), payment_method, project, atau status.

Contoh: payment_method

Nilai yang mungkin: none, payment_method, project, status

project_idsstringopsional

Id proyek dipisah koma; semua proyek bila dikosongkan. Key proyek hanya menghitung proyeknya sendiri.

Contoh: string

Pola: ^(prj_[0-7][0-9a-hjkmnp-tv-z]{25})(,prj_[0-7][0-9a-hjkmnp-tv-z]{25}){0,19}$

Respons (200)

dataobjectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

livemodebooleanwajib

true berarti objek ini ada di live dan bisa melibatkan pembayaran sungguhan; false berarti objek ini ada di sandbox.

currencystringwajib

Mata uang, kode ISO 4217. Saat ini hanya IDR.

Contoh: IDR

Nilai: IDR

fromstringwajib

Hari pertama periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-01

Pola: ^\d{4}-\d{2}-\d{2}$

tostringwajib

Hari terakhir periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-26

Pola: ^\d{4}-\d{2}-\d{2}$

breakdown_bystringwajib

Cara memecah angka: none (satu total), payment_method, project, atau status.

Contoh: payment_method

Nilai yang mungkin: none, payment_method, project, status

seriesarray dari objectwajib

Satu deret untuk tiap baris pemecahan.

keystringwajib

total bila tidak dipecah; selain itu metode, id proyek, atau status deret itu.

Contoh: payment.qris

dailyarray dari objectwajib

Angka tiap hari yang punya data, terlama dahulu.

datestringwajib

Harinya, YYYY-MM-DD waktu Jakarta.

Contoh: 2026-10-26

Pola: ^\d{4}-\d{2}-\d{2}$

amountintegerwajib

Nominal yang lunas hari itu (pemecahan per status juga menghitung pembayaran yang tidak berhasil), dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 1000000

countintegerwajib

Jumlah pembayaran dalam deret ini pada hari tersebut. Breakdown status juga menghitung pembayaran yang tidak berhasil.

Contoh: 1

net_amountintegerwajib

Nominal yang dikreditkan setelah biaya Baiyar, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 993000

fee_amountintegerwajib

Biaya Baiyar untuk pembayaran ini, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 7000

sessions_startedintegerwajib

Jumlah kunjungan checkout yang dimulai hari itu. Hanya dikembalikan untuk breakdown none atau project.

Contoh: 3

sessions_completedintegerwajib

Jumlah kunjungan checkout tersebut yang menghasilkan pembayaran. Hanya dikembalikan untuk breakdown none atau project.

Contoh: 1

metaobjectwajib

Detail request seperti id dan kursor paginasi.

request_idstringwajib

Id request ini. Sebutkan saat bertanya ke dukungan.

Contoh: req_Hy3k9QzT2LmN8vXa

Request yang gagal dijawab dengan bentuk error yang sama; lihat Error.

Request

curl "https://api.baiyar.com/v1/reports/analytics" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Respons

{
  "data": {
    "livemode": false,
    "currency": "IDR",
    "from": "2026-10-01",
    "to": "2026-10-26",
    "breakdown_by": "payment_method",
    "series": [
      {
        "key": "payment.qris",
        "daily": [
          {
            "date": "2026-10-26",
            "amount": 1000000,
            "count": 1,
            "net_amount": 993000,
            "fee_amount": 7000,
            "sessions_started": 3,
            "sessions_completed": 1
          }
        ]
      }
    ]
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}