Laporkan Acara

Peristiwa perilaku pengguna digunakan untuk mencatat informasi penting, seperti kapan peristiwa terjadi, di lingkungan apa, tindakan apa yang dilakukan pengguna, bagaimana mereka melakukannya, dan mengapa mereka melakukannya.

Pelaporan peristiwa pengguna harus dikaitkan dengan EUID.

Alamat Endpoint

POST /v1/event/report

Verifikasi Permintaan

EngageLab REST API menggunakan HTTP Basic Authentication sebagai metode verifikasi. Tambahkan Authorization pada HTTP Header:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Tampilkan blok kode ini di jendela mengambang

base64_auth_string dihasilkan menggunakan algoritma: base64(api_key:api_secret).

Nama header adalah "Authorization", dan nilainya merupakan pasangan "username:password" yang telah dienkode base64 (dipisahkan dengan titik dua).
Untuk MA API, username adalah APIKey dan password adalah APISecret. Silakan konfigurasikan sumber data tipe API untuk mendapatkan APIKey dan API Secret.

Contoh Permintaan

Header Permintaan

> POST /v1/event/report > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

              
              > POST /v1/event/report
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

Tampilkan blok kode ini di jendela mengambang

Body Permintaan

{ "app_key": "96441e4d73207a6517abfbbc", "data": [ { "euid": 10000091198, "event_name": "sign_up", "itime": 1654076420772, "random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e", "properties": { "propertyA": "a", "propertyB": 2 } }, { "euid": 10000091199, "event_name": "login", "itime": 1654076420235, "properties": { "propertyC": "a", "propertyD": 3, "propertyJ": "true", "propertyK": 169, "propertyL": [ "test1", "20231025" ] } } ] }

              
              {
    "app_key": "96441e4d73207a6517abfbbc",
    "data": [
        {
            "euid": 10000091198,
            "event_name": "sign_up",
            "itime": 1654076420772,
            "random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e",
            "properties": {
                "propertyA": "a",
                "propertyB": 2
            }
        },
        {
            "euid": 10000091199,
            "event_name": "login",
            "itime": 1654076420235,
            "properties": {
                "propertyC": "a",
                "propertyD": 3,
                "propertyJ": "true",
                "propertyK": 169,
                "propertyL": [
                    "test1",
                    "20231025"
                 ]
            }
        }
    ]
}

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Field	Tipe	Wajib	Deskripsi
app_key	String	Tidak	AppKey aplikasi/web, dapat digunakan untuk menunjukkan aplikasi sumber peristiwa
data	Array	Ya	Daftar peristiwa perilaku
euid	Long	Ya	ID unik pengguna yang melakukan peristiwa
event_name	String	Ya	Nama peristiwa
itime	Long	Ya	Timestamp spesifik saat peristiwa terjadi, wajib 13 digit (milidetik)
random_id	String	Tidak	ID pelaporan peristiwa, untuk verifikasi keunikan peristiwa; jika kosong, EngageLab akan membuat otomatis
properties	JSON Object	Tidak	Properti peristiwa, key adalah nama properti dan value adalah nilainya. Syarat nama key: huruf kecil, angka, garis bawah, diawali huruf

Parameter Balasan

Field	Tipe	Wajib	Deskripsi
code	Int	Ya	Status keberhasilan pemanggilan API. 0 = sukses, nilai lain = error.
message	String	Ya	Deskripsi hasil pemanggilan API, menjelaskan kode error.

Semua Berhasil

{ "code": 0, "message": "success" }

              
              {
    "code": 0,
    "message": "success"
}

Tampilkan blok kode ini di jendela mengambang

Semua Gagal

{ "code": 40050, "message": "" }

              
              {
    "code": 40050,
    "message": ""
}

Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode	Deskripsi	Penjelasan Detail
40050	Autentikasi antarmuka gagal.	Pastikan project ID dan secret key sudah benar.
40007	EUID kosong.	Silakan periksa nilai EUID.
50031	Project ID tidak valid.	Silakan periksa apakah APIKey dan APISecret sudah benar.
50034	Project ID tidak ditemukan.	Silakan periksa apakah APIKey dan APISecret sudah benar, dan cek apakah proyek sudah dihapus.
50074	Sumber data API tidak ditemukan.	Silakan periksa apakah APIKey dan APISecret sudah benar, dan cek apakah sumber data API sudah dihapus.
55004	Parameter bisnis tidak valid.	Silakan periksa apakah field pada parameter permintaan sudah benar.
55101	Jumlah identifier pengguna melebihi batas.	Pastikan jumlah identifier pengguna tidak melebihi 100.
55102	Terdapat nama atribut pengguna yang tidak valid.	Pastikan nama atribut sesuai syarat penamaan, tidak kosong/tidak menggunakan karakter terlarang/tidak melebihi batas panjang.
55103	Nilai atribut pengguna tidak boleh kosong.	Pastikan nilai atribut pengguna pada body permintaan tidak kosong.
55105	Nilai identifier pengguna tidak boleh melebihi 256 karakter.	Pastikan nilai identifier pengguna tidak melebihi 256 karakter.
55106	Nama identifier pengguna tidak didukung.	Pastikan nama identifier pengguna adalah user_id, anonymous_id, atau registration_id.
55107	Nilai identifier pengguna kosong.	Pastikan nilai identifier pengguna pada body permintaan tidak kosong.
55108	EUID tidak valid.	Silakan periksa nilai EUID.
-1	Kesalahan server internal.	Silakan hubungi dukungan teknis EngageLab.