Statistik
Statistik Data Pengiriman (per Hari)
Data SMS dihitung per hari.
URL
https://sms.api.engagelab.cc/v1/stats_day
https://sms.api.engagelab.cc/v1/stats_day
Tampilkan blok kode ini di jendela mengambang
Metode HTTP Request
GET
GET
Tampilkan blok kode ini di jendela mengambang
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | string | ya | Basic base64(sms_user:sms_key) |
Deskripsi Parameter
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| time_zone | string | tidak | zona waktu, contoh: +8 |
| template_ids | string | tidak | beberapa ID template, pisahkan dengan ; contoh: template_ids=1;2;3. Maksimal 10 |
| sms_users | string | tidak | statistik untuk SMS_USER tertentu, beberapa SMS_USER pisahkan dengan ; contoh: sms_users=a;b;c. Maksimal 10 |
| label_ids | string | tidak | daftar ID label SMS, pisahkan dengan ; contoh: label_ids=123456;456789, maksimal 10 |
| start_date | string | ya | tanggal mulai, format yyyy-MM-dd |
| end_date | string | ya | tanggal akhir, format yyyy-MM-dd |
| msg_type | string | tidak | tipe SMS, 2 untuk SMS internasional |
| aggregate_by | string | tidak | default 0; jika aggregate=1, data diakumulasi |
Catatan:
- Jumlah hari pencarian tidak boleh melebihi 90 hari.
- Jika 'aggregate_by' adalah 1, data diakumulasi berdasarkan 'msg_type'; jika 'aggregate_by' adalah 0, data tidak diakumulasi.
Contoh Permintaan
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balikan
| Parameter | Deskripsi |
|---|---|
| send_date | tanggal pengiriman |
| msg_type | tipe SMS |
| sms_user | SMS_USER |
| template_id | ID template SMS |
| label_id | ID label |
| targets | total target, jumlah permintaan |
| sent | total terkirim |
| process_failed | jumlah proses gagal |
| delivered | jumlah terkirim sukses |
| send_failed | jumlah gagal kirim |
| wait_result | jumlah menunggu hasil |
| billing_count | jumlah tagihan |
| process_failed_percent | persentase proses gagal |
| delivered_percent | persentase terkirim sukses |
| send_failed_percent | persentase gagal kirim |
| wait_result_percent | persentase menunggu hasil |
Contoh Nilai Balikan
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}],
count:1
}
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}],
count:1
}
Tampilkan blok kode ini di jendela mengambang
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
Tampilkan blok kode ini di jendela mengambang
Proses Gagal
Statistik klasifikasi untuk proses pengiriman yang gagal.
URL
https://sms.api.engagelab.cc/v1/stats/process_failed
https://sms.api.engagelab.cc/v1/stats/process_failed
Tampilkan blok kode ini di jendela mengambang
Metode HTTP Request
GET
GET
Tampilkan blok kode ini di jendela mengambang
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | String | ya | Basic base64(smsUser:smsKey) |
Deskripsi Parameter
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| time_zone | string | tidak | zona waktu, contoh: +8 |
| sms_users | string | tidak | statistik untuk SMS_USER tertentu, beberapa SMS_USER pisahkan dengan ; contoh: sms_users=a;b;c. Maksimal 10 |
| start_date | string | ya | tanggal mulai, format yyyy-MM-dd |
| end_date | string | ya | tanggal akhir, format yyyy-MM-dd |
| msg_type | string | tidak | tipe SMS, 2 untuk SMS internasional |
| label_ids | string | tidak | daftar ID label SMS, pisahkan dengan ; contoh: label_ids=123456;456789, maksimal 10 |
| template_ids | string | tidak | beberapa ID template, pisahkan dengan ; contoh: template_ids=1;2;3. Maksimal 10 |
| aggregate_by | string | tidak | default 0; jika aggregate=1, data diakumulasi |
Catatan:
- Jumlah hari pencarian tidak boleh melebihi 90 hari.
- Jika 'aggregate_by' adalah 1, data diakumulasi berdasarkan 'msg_type'; jika 'aggregate_by' adalah 0, data tidak diakumulasi.
Contoh Permintaan
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balikan
| Parameter | Deskripsi |
|---|---|
| send_date | tanggal pengiriman |
| label_id | ID label |
| msg_type | tipe SMS |
| sms_user | SMS_USER |
| template_id | ID template SMS |
| global_block | jumlah blokir global |
| partial_block | jumlah blokir parsial |
| unsubscribe | jumlah berhenti langganan |
| keyword_block | jumlah blokir kata kunci |
| variable_error | jumlah kesalahan variabel |
| content_error | jumlah kesalahan konten |
| frequency_overrun | jumlah kelebihan frekuensi |
| other | jumlah lainnya |
Contoh Nilai Balikan
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}],
count:1
}
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}],
count:1
}
Tampilkan blok kode ini di jendela mengambang
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
{
"result" : {
"msg_type" : "2",
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
Tampilkan blok kode ini di jendela mengambang
Gagal Kirim
Statistik klasifikasi untuk pengiriman SMS yang gagal.
URL
https://sms.api.engagelab.cc/v1/stats/send_failed
https://sms.api.engagelab.cc/v1/stats/send_failed
Tampilkan blok kode ini di jendela mengambang
Metode HTTP Request
GET
GET
Tampilkan blok kode ini di jendela mengambang
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | String | ya | Basic base64(sms_user:sms_key) |
Deskripsi Parameter
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| time_zone | string | tidak | zona waktu, contoh: +8 |
| sms_users | string | tidak | statistik untuk SMS_USER tertentu, beberapa SMS_USER pisahkan dengan ; contoh: sms_users=a;b;c. Maksimal 10 |
| start_date | string | ya | tanggal mulai, format yyyy-MM-dd |
| end_date | string | ya | tanggal akhir, format yyyy-MM-dd |
| msg_type | string | tidak | tipe SMS, 2 untuk SMS internasional |
| label_ids | string | tidak | daftar ID label SMS, pisahkan dengan ; contoh: label_ids=123456;456789, maksimal 10 |
| template_ids | string | tidak | beberapa ID template, pisahkan dengan ; contoh: template_ids=1;2;3. Maksimal 10 |
| aggregate_by | string | tidak | default 0; jika aggregate=1, data diakumulasi |
Tips:
- Jumlah hari pencarian tidak boleh melebihi 90 hari.
- Jika 'aggregate_by' adalah 1, data diakumulasi berdasarkan 'msg_type'; jika 'aggregate_by' adalah 0, data tidak diakumulasi.
Contoh Permintaan
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balikan
| Parameter | Deskripsi |
|---|---|
| send_date | tanggal pengiriman |
| label_id | ID label |
| msg_type | tipe SMS |
| sms_user | SMS_USER |
| template_id | ID template SMS |
| empty | jumlah nomor kosong |
| out_of_service | jumlah tidak aktif |
| blacklist | jumlah masuk daftar hitam |
| busy | jumlah sibuk |
| no_answer | jumlah tidak menjawab |
| interception | jumlah intersepsi |
| break_down | jumlah gangguan |
| not_in_service | jumlah tidak dalam layanan |
| power_off | jumlah mati daya |
| other | jumlah lainnya |
Contoh Nilai Balikan
aggregate_by=0
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
Tampilkan blok kode ini di jendela mengambang
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
Tampilkan blok kode ini di jendela mengambang
