Dokumen ini menjelaskan cara mendapatkan analisis pengiriman pesan, percakapan, dan template, seperti jumlah pesan yang dikirim dari nomor telepon bisnis, jumlah percakapan dan biayanya untuk Akun WhatsApp Business (WABA), atau berapa kali template tertentu telah dibaca.
Hanya metrik untuk nomor telepon bisnis dan template yang terkait dengan WABA Anda pada saat permintaan diajukan yang akan disertakan dalam tanggapan.
Gunakan endpoint Akun WhatsApp Business untuk mendapatkan analytics.
GET /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?fields=<FIELDS>.<FILTERING_PARAMETER>
Placeholder | Deskripsi | Contoh Nilai |
---|---|---|
| Wajib. Metrik. Nilai dapat berupa salah satu dari: |
|
| Wajib. Parameter pemfilteran metrik. Tambahkan parameter pemfilteran tambahan menggunakan titik-titik. Untuk kemungkinan nilai, lihat: |
|
Kolom analytics
menyediakan jumlah dan jenis pesan yang dikirim dan disampaikan oleh nomor telepon yang terkait dengan WABA tertentu — untuk metrik percakapan, lihat Analitik Percakapan. Saat memanggil /{whatsapp-business-account-ID}?fields=analytics.{filtering-parameters}
, Anda dapat melampirkan parameter berikut.
Nama | Deskripsi (Klik panah di kolom kiri untuk opsi yang didukung.) |
---|---|
jenis: cap waktu UNIX | Wajib. Tanggal mulai untuk rentang tanggal analytics yang ingin Anda ambil. |
jenis: Cap waktu UNIX | Wajib. Tanggal akhir untuk rentang tanggal analytics yang ingin Anda ambil. |
jenis: String | Wajib. Granularitas yang ingin Anda ambil analitiknya. |
jenis: Array | Opsional. Array nomor telepon yang ingin Anda ambil analytics-nya. Jika tidak dimasukkan, semua nomor telepon yang ditambahkan ke Akun WhatsApp Business (WABA) Anda akan disertakan. |
jenis: Array | Opsional. Jenis pesan (pesan notifikasi dan/atau pesan dukungan pelanggan) yang ingin Anda ambil notifikasinya. Sediakan array dan sertakan |
jenis: Array | Opsional. Negara yang ingin Anda ambil analytics-nya. Sediakan array dengan kode negara 2 huruf untuk negara yang ingin Anda sertakan. Jika tidak disediakan, analytics akan ditampilkan untuk semua negara yang telah Anda berkomunikasi. |
Skenario: Anda perlu mendapatkan jumlah pesan yang dikirimkan dan disampaikan oleh semua nomor telepon yang terkait dengan WABA Anda.
Solusi yang Disarankan:Kumpulkan URL yang ingin Anda panggil dan sertakan parameter pemfilteran berikut: start
, end
, granularity
. Lalu, buat permintaan GET
ke URL itu:
curl -i -X GET \
"https://graph.facebook.com/v20.0
/{whatsapp-business-account-ID}
?fields=analytics
.start(1543543200)
.end(1544148000)
.granularity(DAY)
&access_token={access-token}"
Tanggapan yang berhasil akan memberikan objek analytics
dengan data yang Anda minta:
{ "analytics": { "phone_numbers": [ "16505550111", "16505550112", "16505550113" ], "country_codes": [ "US", "BR" ], "granularity": "DAY", "data_points": [ { "start": 1543543200, "end": 1543629600, "sent": 196093, "delivered": 179715 }, { "start": 1543629600, "end": 1543716000, "sent": 147649, "delivered": 139032 }, { "start": 1543716000, "end": 1543802400, "sent": 61988, "delivered": 58830 }, { "start": 1543802400, "end": 1543888800, "sent": 132465, "delivered": 124392 } # more data points ] }, "id": "102290129340398" }
Kolom conversation_analytics
memberikan biaya dan informasi percakapan untuk WABA tertentu. Saat memanggil /{whatsapp-business-account-ID}?fields=conversation_analytics.{filtering-parameters}
, Anda dapat melampirkan parameter berikut.
Nama | Deskripsi (Klik panah di kolom kiri untuk opsi yang didukung.) |
---|---|
jenis: cap waktu UNIX | Wajib. Tanggal mulai untuk rentang tanggal analytics yang ingin Anda ambil. |
jenis: Cap waktu UNIX | Wajib. Tanggal akhir untuk rentang tanggal analytics yang ingin Anda ambil. |
jenis: String | Wajib. Granularitas yang ingin Anda ambil analitiknya. |
jenis: Array | Opsional. Array nomor telepon yang ingin Anda ambil analytics-nya. Jika tidak disediakan, semua nomor telepon yang ditambahkan ke Akun WhatsApp Business (WABA) Anda akan disertakan. |
| Opsional. Daftar metrik yang ingin Anda terima. Jika Anda mengirim daftar kosong, kami menampilkan hasil untuk semua jenis metrik. |
| Opsional. Daftar kategori percakapan. Jika Anda mengirim daftar kosong, kami menampilkan hasil untuk semua kategori percakapan. |
| Opsional. Daftar jenis percakapan. Jika Anda mengirim daftar kosong, kami menampilkan hasil untuk semua jenis percakapan. |
| Opsional. Daftar arah percakapan. Jika Anda mengirim daftar kosong, kami menampilkan hasil untuk semua arah percakapan. |
| Opsional. Daftar perincian yang ingin Anda terapkan pada metrik Anda. Jika Anda mengirimkan daftar kosong, kami akan menampilkan hasil tanpa perincian apa pun. |
Data Analytics merupakan perkiraan dan mungkin berbeda dari yang ditampilkan di faktur karena sedikit variasi dalam pemrosesan data.
Dengan rentang waktu tertentu, Anda bisa mendapatkan informasi percakapan dan biaya yang terkait dengan WABA Anda. Jika mau, Anda dapat memfilter dan memperinci hasil Anda. Lihat contoh kode di bawah ini untuk contoh.
Skenario: Dalam sebulan, Anda ingin mengambil semua percakapan dan informasi biaya untuk semua nomor telepon yang terkait dengan WABA.
Solusi yang Disarankan:Kumpulkan URL yang ingin Anda panggil dan sertakan parameter pemfilteran berikut:
start
: Awal rentang waktu Anda. Dalam hal ini, awal bulan yang Anda inginkan metriknya.end
: Akhir rentang waktu Anda. Dalam hal ini, akhir bulan yang Anda inginkan metriknya.granularity
: Tingkat granularitas yang diinginkan untuk titik data Anda. Dalam contoh di bawah, kami menggunakan MONTHLY
, jadi setiap titik data mewakili data satu bulan.phone_numbers
: Kirim array kosong dan kami akan menampilkan informasi untuk semua nomor telepon yang terkait dengan WABA.dimensions
: Atur ke semua perincian yang tersedia: "CONVERSATION_CATEGORY"
, "CONVERSATION_TYPE"
, "COUNTRY"
, dan "PHONE"
.Dalam hal ini, Anda tidak perlu menentukan country_codes
, metric_types
, conversation_types
, dan conversation_categories
. Jika Anda tidak mengirimkan apa pun kepada kami untuk kolom tersebut, kami akan menampilkan semua opsi yang tersedia. Setelah Anda menyiapkan URL, buat permintaan GET:
curl -i -X GET
"https://graph.facebook.com/v20.0
/{whatsapp-business-account-id}
?fields=conversation_analytics
.start(1685602800).end(1688194800)
.granularity(MONTHLY)
.phone_numbers([])
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY","PHONE"])
&access_token={access-token}"
Tanggapan yang berhasil akan memberikan objek conversation_analytics
dengan data yang Anda minta. Dalam contoh berikut, WABA hanya berisi satu nomor telepon.
{ "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685602800, "end": 1688194800, "conversation": 1558, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_direction": "UNKNOWN", "conversation_category": "AUTHENTICATION", "cost": 15.58 }, { "start": 1685602800, "end": 1688194800, "conversation": 2636, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_category": "MARKETING", "cost": 26.36 }, { "start": 1685602800, "end": 1688194800, "conversation": 2238, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_category": "SERVICE", "cost": 22.38 }, { "start": 1685602800, "end": 1688194800, "conversation": 1782, "phone_number": "15550458206", "country": "US", "conversation_type": "REGULAR", "conversation_category": "UTILITY", "cost": 17.82 }, { "start": 1685602800, "end": 1688194800, "conversation": 1568, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "AUTHENTICATION", "cost": 15.68 }, { "start": 1685602800, "end": 1688194800, "conversation": 2716, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "MARKETING", "cost": 27.16 }, { "start": 1685602800, "end": 1688194800, "conversation": 2180, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "SERVICE", "cost": 21.8 }, { "start": 1685602800, "end": 1688194800, "conversation": 1465, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_TIER", "conversation_category": "UTILITY", "cost": 14.65 }, { "start": 1685602800, "end": 1688194800, "conversation": 1433, "phone_number": "15550458206", "country": "US", "conversation_type": "FREE_ENTRY_POINT", "conversation_category": "SERVICE", "cost": 14.33 } ] } ] }, "id": "102290129340398", }
Skenario: Dalam rentang waktu tertentu, Anda ingin mengambil semua percakapan dan informasi biaya untuk nomor telepon tertentu yang terkait dengan WABA. Di hasilnya, Anda ingin menggunakan semua kemungkinan perincian. Anda memerlukan setiap titik data untuk mewakili data selama setengah jam.
Solusi yang Disarankan: Kumpulkan URL yang ingin Anda panggil dan sertakan parameter pemfilteran berikut:
start
: Awal rentang waktu Anda. end
: Akhir rentang waktu Anda.granularity
: Tingkat perincian yang diinginkan untuk titik data Anda. Dalam contoh di bawah, kami menggunakan HALF_HOUR
, jadi setiap titik data mewakili data setengah jam.phone_numbers
: Nomor telepon yang Anda perlukan informasinya.dimensions
: Atur ke semua perincian yang tersedia: CONVERSATION_CATEGORY
, CONVERSATION_TYPE
, COUNTRY
, dan PHONE
.Dalam hal ini, Anda tidak perlu menentukan country_codes
, metric_types
, conversation_types
, atau conversation_categories
. Jika Anda tidak mengirimkan apa pun kepada kami untuk kolom tersebut, kami akan menampilkan semua opsi yang tersedia. Setelah Anda menyiapkan URL, buat permintaan GET:
curl -i -X GET \
"https://graph.facebook.com/v20.0
/{whatsapp-business-account-id}
?fields=conversation_analytics
.start(1685602800)
.end(1685689200)
.granularity(HALF_HOUR)
.phone_numbers(["19195552584"])
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY,PHONE"])
&access_token=your-access-token"
Tanggapan yang berhasil akan memberikan objek conversation_analytics
dengan data yang Anda minta:
{ "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685602800, "end": 1685604600, "conversation": 4, "phone_number": "19195552584", "country": "US", "conversation_type": "REGULAR", "conversation_direction": "UNKNOWN", "conversation_category": "SERVICE", "cost": 0.0232 }, { "start": 1685602800, "end": 1685604600, "conversation": 4, "phone_number": "19195552584", "country": "US", "conversation_type": "REGULAR", "conversation_direction": "UNKNOWN", "conversation_category": "MARKETING", "cost": 0.0232 }, # ... more data points ] } ] }, "id": "102290129340398" }
Skenario: Dalam rentang waktu tertentu, Anda ingin mengambil semua percakapan dan informasi biaya untuk semua nomor telepon yang terkait dengan WABA. Di hasilnya, Anda ingin memperinci berdasarkan jenis percakapan.
Solusi yang Disarankan: Kumpulkan URL yang ingin Anda panggil dan sertakan parameter pemfilteran berikut:
start
: Awal rentang waktu Anda. end
: Akhir rentang waktu Anda.granularity
: Tingkat granularitas yang diinginkan untuk titik data Anda. Dalam contoh di bawah, kami menggunakan MONTHLY
, jadi setiap titik data mewakili data setengah bulan.phone_numbers
: Kirim array kosong dan kami akan memberikan informasi untuk semua nomor telepon yang terkait dengan WABA.dimensions
: Diatur ke CONVERSATION_TYPE
.Dalam hal ini, Anda tidak perlu menentukan country_codes
, metric_types
, conversation_types
, conversation_directions
, atau conversation_categories
. Jika Anda tidak mengirimkan apa pun kepada kami untuk kolom tersebut, kami akan menampilkan semua opsi yang tersedia. Setelah Anda menyiapkan URL, buat permintaan GET:
curl -i -X GET
"https://graph.facebook.com/v20.0
/{whatsapp-buiness-account-id}
?fields=conversation_analytics
.start(1643702400).end(1646121600)
.granularity(MONTHLY)
.phone_numbers([])
.dimensions([CONVERSATION_TYPE])
&access_token={access-token}"
Tanggapan yang berhasil akan menampilkan objek conversation_analytics
dengan data yang Anda minta:
{ "data": [ { "data_points": [ { "start": 1643702400, "end": 1646121600, "conversation": 8500, "conversation_type": "REGULAR", "cost": 88.1010 }, { "start": 1643702400, "end": 1646121600, "conversation”: 1000, "conversation_type": "FREE_TIER", "cost": 0.0000 } { "start": 1643702400, "end": 1646121600, "conversation”: 250, "conversation_type": "FREE_ENTRY_POINT", "cost": 0.0000 } ] } ] }
Permintaan:
curl -i -X GET \
"https://graph.facebook.com/v20.0
/{whatsapp-buiness-account-id}
?fields=conversation_analytics
.start(1685527200)
.end(1685613600)
.granularity(HALF_HOUR)
.conversation_categories(["MARKETING","AUTHENTICATION"])
.dimensions(["CONVERSATION_CATEGORY"])
&access_token={access-token}"
Tanggapan:
{ "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685529000, "end": 1685530800, "conversation": 2, "conversation_category": "AUTHENTICATION", "cost": 0.0128 }, { "start": 1685527200, "end": 1685529000, "conversation": 3, "conversation_category": "MARKETING", "cost": 0.0432 } ] } ] }, "id": "102290129340398" }
Permintaan:
curl -i -X GET \
"https://graph.facebook.com/v20.0
/{whatsapp-buiness-account-id}
?fields=conversation_analytics
.start(1685527200)
.end(1685613600)
.granularity(HALF_HOUR)
.conversation_categories(["MARKETING","AUTHENTICATION"])
.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE"])
&access_token={access-token}"
Tanggapan:
{ "conversation_analytics": { "data": [ { "data_points": [ { "start": 1685527200, "end": 1685529000, "conversation": 3, "conversation_type": "REGULAR", "conversation_category": "MARKETING", "cost": 0.0432 }, { "start": 1685529000, "end": 1685530800, "conversation": 2, "conversation_type": "REGULAR", "conversation_category": "AUTHENTICATION", "cost": 0.0128 } ] } ] }, "id": "102290129340398" }
Analitik template menjelaskan berapa kali template terkirim, tersampaikan, dan terbaca, serta berapa kali tombol URL atau tombol Balasan Cepat dalam template telah diklik.
Data ditampilkan dengan perincian harian dalam zona waktu UTC dengan periode kilas balik hingga 90 hari. Analitik template juga dapat ditemukan di panel Pengelola WhatsApp > Template pesan > Perincian template > Insight.
MARKETING
atau UTILITY
.Untuk melaporkan bug analytics template, kirimkan tiket Dukungan Langsung dengan pilihan berikut:
Anda harus mengonfirmasikan analytics template pada akun WhatsApp Business Anda sebelum Anda bisa mendapatkan analytics template. Anda dapat mengonfirmasi analytics template menggunakan Pengelola atau API WhatsApp. Untuk mengonfirmasikan melalui API, kirim permintaan berikut:
POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>?is_enabled_for_insights=true
Setelah dikonfirmasi, kami akan mulai mengambil analytics template untuk Akun WhatsApp Business. Setelah dikonfirmasi, analytics template tidak dapat dinonaktifkan.
Setelah berhasil, API akan menanggapi dengan ID Akun WhatsApp Business Anda. Contoh:
{ "id": 102290129340398 }
Nama | Deskripsi | Contoh Nilai |
---|---|---|
Cap Waktu UNIX | Wajib. Cap waktu mulai untuk rentang tanggal analytics yang ingin Anda ambil. Karena analytics template disediakan dengan granularitas harian di zona waktu UTC, cap waktu mulai selain 00:00 UTC akan diperbaiki menjadi 00:00 UTC sebelumnya. |
|
Cap Waktu UNIX | Wajib. Tanggal akhir untuk rentang tanggal analytics yang ingin Anda ambil. Karena analytics template disediakan dengan granularitas harian di zona waktu UTC, cap waktu akhir selain 00:00 UTC akan diperbaiki menjadi 00:00 UTC berikutnya. |
|
Enum | Wajib. Granularitas yang ingin Anda ambil analitiknya. Nilai harus |
|
Array ID | Wajib. Array ID template yang ingin Anda ambil analytics-nya. Maksimal 10. |
|
Array enum | Opsional.
Jenis metrik yang ingin Anda ambil. Jika diabaikan atau array kosong, analytics untuk semua jenis metrik akan ditampilkan. Kemungkinan nilai:
Klik hanya dikembalikan untuk tombol URL dan tombol balas cepat di template yang dikategorikan sebagai Metrik biaya dikembalikan sebagai array objek biaya, masing-masing dengan jenis dan nilai. Jenis dapat berupa:
|
|
Skenario: Dengan jangka waktu 1 hari, dapatkan semua jenis metrik analitik template untuk template autentikasi dan template marketing dengan tombol URL.
Contoh Permintaan:
curl -g 'https://graph.facebook.com/v20.0
/109259195336416/template_analytics?start=1718064000&end=1718122745&granularity=daily&metric_types=cost%2Cclicked%2Cdelivered%2Cread%2Csent&template_ids=[1421988012088524%2C2632273056924580]' \
-H 'Authorization: Bearer EAAJB...'
Contoh Tanggapan:
{ "data": [ { "granularity": "DAILY", "product_type": "cloud_api", // Only available to businesses in Marketing Messages Lite API alpha "data_points": [ { "template_id": "1421988012088524", "start": 1718064000, "end": 1718150400, "sent": 1, "delivered": 1, "read": 1, "cost": [ { "type": "amount_spent", "value": 0.01 }, { "type": "cost_per_delivered", "value": 0.01 } ] }, { "template_id": "2632273056924580", "start": 1718064000, "end": 1718150400, "sent": 1, "delivered": 1, "read": 1, "clicked": [ { "type": "url_button", "button_content": "Contact Support", "count": 1 } ], "cost": [ { "type": "amount_spent", "value": 0.03 }, { "type": "cost_per_delivered", "value": 0.03 }, { "type": "cost_per_url_button_click", "value": 0.03 } ] } ] } ], "paging": { "cursors": { "before": "MAZDZD", "after": "MjQZD" } } }
Anda dapat menonaktifkan pelacakan klik tombol pada masing-masing template dengan mengatur kolom cta_url_link_tracking_opted_out
ke true
. Setelah dinonaktifkan, API tidak akan lagi menampilkan properti yang diklik dalam analitik template atau menampilkan keterlibatan/klik tombol di Pengelola WhatsApp saat melihat insight template.
POST /<TEMPLATE_ID> ?cta_url_link_tracking_opted_out=<OPT_OUT> &category=<TEMPLATE_CATEGORY>
Placeholder | Deskripsi | Contoh Nilai |
---|---|---|
ID Template | Wajib. ID template. |
|
Boolean | Wajib. Menunjukkan apakah pelacakan klik tombol template dinonaktifkan. Set ke Nilai ini diset ke |
|
String | Wajib. Kategori template saat ini. Jika Anda mengatur kategori template ke nilai selain kategori saat ini, status template akan diatur ke |
|
curl -X POST 'https://graph.facebook.com/v20.0
/245435364965041?cta_url_link_tracking_opted_out=true&category=marketing' \
-H 'Authorization: Bearer EAAJB...'
Setelah berhasil, API akan menanggapi dengan:
{ "success": true }
Untuk melihat daftar semua kemungkinan nilai tiap kolom, baca referensi Graph API dari kolom Analitik Akun WhatsApp Business.