Logo Site EngageLab Mark Colored TransparentDokumen
MA
Beranda Dokumen
Ikhtisar ProdukPanduan KonsolREST APISDK KlienKeamanan DataLog Perubahan
Cari
Masuk
REST API/Statistik Journey
REST APIStatistik Journey...

Statistik Journey

Terakhir diperbarui：19 hari yang lalu

Menanyakan data statistik, termasuk "Statistik Ringkasan Journey", "Statistik Pengiriman Pesan", dan "Statistik Pengiriman WebHook".

Statistik Journey

Menanyakan data journey untuk jumlah entri, konversi target, keluar awal, keluar normal, dan yang sedang berjalan.

Endpoint

GET /v1/stats/journey

Autentikasi

REST API EngageLab menggunakan HTTP Basic Authentication. Tambahkan header Authorization dalam permintaan HTTP:

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}
Tampilkan blok kode ini di jendela mengambang

base64_auth_string dihasilkan dengan: base64(api_key:api_secret)

  • Nama Header adalah "Authorization", dan nilainya adalah pasangan "username:password" yang dienkode base64 (dengan titik dua di antaranya).
  • Dalam konteks MA API, username adalah APIKey, dan password adalah APISecret. Dapatkan APIKey dan APISecret dengan menambahkan sumber data tipe API.

Contoh Permintaan

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Kolom Tipe Wajib Deskripsi
journey_id String Ya ID Journey. Beberapa ID dipisahkan dengan koma, maksimal 100.
time_unit String Ya Unit waktu. Nilai: HOUR, DAY.
start_time String Ya Waktu mulai dalam format yyyy-MM-dd.
end_time String Ya Waktu akhir dalam format yyyy-MM-dd. Waktu akhir >= Waktu mulai. Rentang maksimal 31 hari.

Parameter Respons

Kolom Tipe Deskripsi
code Integer Apakah panggilan API berhasil. 0 menunjukkan berhasil atau berhasil sebagian; nilai lain menunjukkan gagal.
message String Deskripsi hasil panggilan API. success jika berhasil.
data Array<Object> Data statistik yang dikembalikan.
journey_id Long ID Journey.
time_unit String Unit waktu. Nilai: HOUR, DAY.
error_code Int Apakah statistik journey berhasil diambil. 0 menunjukkan berhasil; nilai lain menunjukkan gagal.
detail Array<Object> Detail per jam/per hari.
time String Tanggal statistik dalam respons, dalam format yyyy-MM-dd atau yyyy-MM-dd HH.
entry_count Long Jumlah entri.
conversion_count Long Jumlah konversi.
completion_count Long Jumlah keluar normal.
early_exit_count Long Jumlah keluar awal.
in_progress_count Long Jumlah yang sedang berjalan, yaitu yang masih dalam journey pada saat end_time atau waktu.

Semua Berhasil

{ "code": 0, "message": "success", "data": [ { "journey_id":123, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }, { "journey_id":234, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }] }
              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id":123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id":234,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  }]
}
Tampilkan blok kode ini di jendela mengambang

Semua Gagal

{ "code": 50219, "message": "The number of JourneyIDs exceeds 100." }
              
              {
  "code": 50219,
  "message": "The number of JourneyIDs exceeds 100."
}
Tampilkan blok kode ini di jendela mengambang

Berhasil Sebagian

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "time": "2026-05-28", "entry_count": 312, "conversion_count": 24, "early_exit_count": 41, "completion_count": 247, "in_progress_count": 156 } ] }, { "journey_id": -1, "error_code": 50221 }] }
              
              {  
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "time": "2026-05-28",
        "entry_count": 312,
        "conversion_count": 24,
        "early_exit_count": 41,
        "completion_count": 247,
        "in_progress_count": 156
      }
    ]
  },
  {
      "journey_id": -1,
      "error_code": 50221
  }]
}
Tampilkan blok kode ini di jendela mengambang

Statistik Pengiriman Pesan

Menanyakan data pengiriman, pengantaran, klik, dan data lainnya untuk setiap komponen pesan dalam suatu journey.

Endpoint

GET /v1/stats/journey/message

Contoh Permintaan

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Kolom Tipe Wajib Deskripsi
journey_id String Ya ID Journey. Beberapa ID dipisahkan dengan koma, maksimal 100.
time_unit String Ya Unit waktu. Nilai: HOUR, DAY.
start_time String Ya Waktu mulai dalam format yyyy-MM-dd.
end_time String Ya Waktu akhir dalam format yyyy-MM-dd. Waktu akhir >= Waktu mulai. Rentang maksimal 31 hari.

Parameter Respons

Kolom Tipe Deskripsi
code Integer Apakah panggilan API berhasil. 0 menunjukkan berhasil atau berhasil sebagian; nilai lain menunjukkan gagal.
message String Deskripsi hasil panggilan API. success jika berhasil.
data Array<Object> Data statistik yang dikembalikan.
journey_id Long ID Journey.
time_unit String Unit waktu. Nilai: HOUR, DAY.
error_code Int Apakah statistik journey berhasil diambil. 0 menunjukkan berhasil; nilai lain menunjukkan gagal.
detail Array<Object> Detail per jam/per hari.
time String Tanggal statistik dalam respons, dalam format yyyy-MM-dd atau yyyy-MM-dd HH.
component_id Long ID komponen pesan.
component_name String Nama komponen pesan, misalnya APP_PUSH_1, EMAIL_2.
channel String Tipe saluran.
entry_count Long Jumlah entri.
plan_count Long Jumlah target yang direncanakan.
send_count Long Jumlah terkirim.
delivery_count Long Jumlah terantar.
impression_count Long Jumlah tayangan.
open_count Long Jumlah buka.
click_count Long Jumlah klik.
conversion_count Long Jumlah konversi.
revenue_count Long Jumlah peristiwa penghasil pendapatan.
revenue_amount Number Total jumlah pendapatan.

Semua Berhasil

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-28", "entry_count": 320, "plan_count": 312, "send_count": 290, "delivery_count": 270, "impression_count": 198, "open_count": 155, "click_count": 24, "conversion_count": 8, "revenue_count": 7, "revenue_amount": 488.50 }, { "component_id": 8801, "component_name": "EMAIL_1", "channel": "Email", "time": "2026-05-29", "entry_count": 305, "plan_count": 298, "send_count": 280, "delivery_count": 261, "impression_count": 185, "open_count": 144, "click_count": 19, "conversion_count": 6, "revenue_count": 5, "revenue_amount": 312.00 } ] } ] }
              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-28",
        "entry_count": 320,
        "plan_count": 312,
        "send_count": 290,
        "delivery_count": 270,
        "impression_count": 198,
        "open_count": 155,
        "click_count": 24,
        "conversion_count": 8,
        "revenue_count": 7,
        "revenue_amount": 488.50
      },
      {
        "component_id": 8801,
        "component_name": "EMAIL_1",
        "channel": "Email",
        "time": "2026-05-29",
        "entry_count": 305,
        "plan_count": 298,
        "send_count": 280,
        "delivery_count": 261,
        "impression_count": 185,
        "open_count": 144,
        "click_count": 19,
        "conversion_count": 6,
        "revenue_count": 5,
        "revenue_amount": 312.00
      }
    ]
  }
]
}
Tampilkan blok kode ini di jendela mengambang

Statistik Pengiriman WebHook

Menanyakan data permintaan dan keberhasilan untuk setiap komponen Webhook dalam suatu journey.

Endpoint

GET /v1/stats/journey/webhook

Contoh Permintaan

curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \ -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
              
              curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
  -H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Kolom Tipe Wajib Deskripsi
journey_id String Ya ID Journey. Beberapa ID dipisahkan dengan koma, maksimal 100.
time_unit String Ya Unit waktu. Nilai: HOUR, DAY.
start_time String Ya Waktu mulai dalam format yyyy-MM-dd.
end_time String Ya Waktu akhir dalam format yyyy-MM-dd. Waktu akhir >= Waktu mulai. Rentang maksimal 31 hari.

Parameter Respons

Kolom Tipe Deskripsi
code Integer Apakah panggilan API berhasil. 0 menunjukkan berhasil atau berhasil sebagian; nilai lain menunjukkan gagal.
message String Deskripsi hasil panggilan API. success jika berhasil.
data Array<Object> Data statistik yang dikembalikan.
journey_id Long ID Journey.
time_unit String Unit waktu. Nilai: HOUR, DAY.
error_code Int Apakah statistik journey berhasil diambil. 0 menunjukkan berhasil; nilai lain menunjukkan gagal.
detail Array<Object> Detail per jam/per hari.
time String Tanggal statistik dalam respons, dalam format yyyy-MM-dd atau yyyy-MM-dd HH.
component_id Long ID komponen pesan.
component_name String Nama komponen pesan, misalnya APP_PUSH_1, EMAIL_2.
entry_count Long Jumlah entri ke komponen Webhook.
send_count Long Jumlah permintaan berhasil.
send_failure_count Long Jumlah permintaan gagal.

Semua Berhasil

{ "code": 0, "message": "success", "data": [ { "journey_id": 123, "time_unit": "DAY", "error_code": 0, "detail": [ { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-28", "entry_count": 520, "send_count": 498, "send_failure_count": 22 }, { "component_id": 9001, "component_name": "WEBHOOK_1", "time": "2026-05-29", "entry_count": 610, "send_count": 600, "send_failure_count": 10 } ] } ] }
              
              {
  "code": 0,
  "message": "success",
  "data": [
    {
      "journey_id": 123,
      "time_unit": "DAY",
      "error_code": 0,
      "detail": [
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-28",
        "entry_count": 520,
        "send_count": 498,
        "send_failure_count": 22
      },
      {
        "component_id": 9001,
        "component_name": "WEBHOOK_1",
        "time": "2026-05-29",
        "entry_count": 610,
        "send_count": 600,
        "send_failure_count": 10
      }
    ]
  }
]
}
Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode Error Umum

HTTP Status code message Deskripsi
401 40050 authorization invalid Autentikasi gagal.
429 55110 Too many requests, please try again later. Batas laju terlampaui.
400 40001 http参数不合法 Pesan HTTP tidak valid atau parameter path/query yang diperlukan tidak valid.
400 40002 业务参数不合法 Validasi format parameter, enum, atau tipe gagal.
400 50034 项目不存在 Proyek yang terikat dengan APIKey tidak ada.
500 -1 服务器内部错误 Kesalahan server internal.

Kode Error Statistik Journey

HTTP Status code message Deskripsi
400 50202 Journey does not exist. Journey tidak ada atau bukan milik proyek saat ini.
400 50217 Invalid time range. start_time > end_time, atau rentang kueri melebihi 31 hari.
400 50219 The number of JourneyIDs exceeds 100. Jumlah JourneyID melebihi batas 100.
400 50220 Invalid time_unit. Nilai time_unit tidak valid; hanya HOUR dan DAY yang didukung.
400 50221 Invalid journey_id format. Format JourneyID tunggal tidak valid (kolom error_code, menunjukkan kueri journey tertentu gagal).
Icon Solid Transparent White Qiyu
Hubungi Sales