เอกสารนี้จะอธิบายวิธีเรียกดูข้อความ การสนทนา และการวิเคราะห์เทมเพลต เช่น จำนวนข้อความที่ส่งจากหมายเลขโทรศัพท์ของธุรกิจ จำนวนการสนทนา และค่าใช้จ่ายสำหรับบัญชี WhatsApp Business (WABA) หรือจำนวนครั้งที่มีการอ่านเทมเพลตที่กำหนด
ระบบจะรวมเฉพาะเกณฑ์ชี้วัดสำหรับหมายเลขโทรศัพท์ธุรกิจและเทมเพลตที่เชื่อมโยงกับ WABA ของคุณ ณ เวลาที่ร้องขอเท่านั้นในการตอบกลับ
ใช้ตำแหน่งข้อมูลบัญชี WhatsApp Business เพื่อรับการวิเคราะห์
GET /<WHATSAPP_BUSINESS_ACCOUNT_ID> ?fields=<FIELDS>.<FILTERING_PARAMETER>
ตัวยึดตำแหน่ง | คำอธิบาย | ค่าตัวอย่าง |
---|---|---|
| จำเป็นต้องระบุ เกณฑ์ชี้วัด ค่าอาจเป็นหนึ่งในรายการต่อไปนี้ |
|
| จำเป็นต้องระบุ พารามิเตอร์การกรองเกณฑ์ชี้วัด เพิ่มพารามิเตอร์การกรองเพิ่มเติมโดยใช้จุด สำหรับค่าที่เป็นไปได้ ให้ดูที่ |
|
ช่อง analytics
จะให้จำนวนและประเภทของข้อความที่ส่งออกและส่งถึงผู้รับโดยหมายเลขโทรศัพท์ที่เกี่ยวข้องกับ WABA ที่เฉพาะเจาะจง หากต้องการข้อมูลเกี่ยวกับเกณฑ์ชี้วัดการสนทนา โปรดดูการวิเคราะห์การสนทนา เมื่อเร���ยกใช้ /{whatsapp-business-account-ID}?fields=analytics.{filtering-parameters}
คุณสามารถแนบพารามิเตอร์ต่อไปนี้
ชื่อ | คำอธิบาย (คลิกที่ลูกศรในคอลัมน์ด้านซ้ายเพื่อดูตัวเลือกที่รองรับ) |
---|---|
ประเภท: การประทับเวลา UNIX | จำเป็นต้องระบุ วันที่เริ่มต้นสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ |
ประเภท: ประทับเวลา UNIX | จำเป็นต้องระบุ วันที่สิ้นสุดสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ |
ประเภท: สตริง | จำเป็นต้องระบุ ความละเอียดของข้อมูลการวิเคราะห์ที่คุณต้องการเรียกดู |
ประเภท: อาร์เรย์ | ระบุหรือไม่ก็ได้ อาร์เรย์ของหมายเลขโทรศัพท์ที่คุณต้องการดึงข้อมูลการวิเคราะห์ หากไม่ได้ระบุไว้ ระบบจะใส่หมายเลขโทรศัพท์ทุกหมายเลขที่เพิ่มไว้กับ WABA ของคุณ |
ประเภท: อาร์เรย์ | ระบุหรือไม่ก็ได้ ประเภทของข้อความ (ข้อความแจ้งเตือนและ/หรือข้อความฝ่ายบริการลูกค้า) ซึ่งคุณต้องการดึงข้อมูลการแจ้งเตือน ระบุอาร์เรย์และใส่ |
ประเภท: อาร์เรย์ | ระบุหรือไม่ก็ได้ ประเทศที่คุณต้องการดึงข้อมูลการวิเคราะห์ ระบุอาร์เรย์พร้อมรหัสประเทศ 2 ตัวอักษรสำหรับประเทศที่คุณต้องการใส่ หากไม่ได้ระบุไว้ ระบบจะส่งคืนการวิเคราะห์สำหรับทุกประเทศที่คุณติดต่อสื่อสารด้วย |
สถานการณ์: คุณต้องการรับจำนวนข้อความที่ส่งออกและส่งถึงผู้รับโดยหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABA ของคุณ
โซลูชั่นที่แนะนำ:รวบรวม URL ที่คุณต้องการเรียกใช้ และรวมพารามิเตอร์การกรองต่อไปนี้เข้าไปด้วย: start
, end
, granularity
จากนั้น ให้ส่งคำขอ GET
ไปยัง URL ดังกล่าว ดังนี้
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}"
การตอบกลับที่สำเร็จจะส่งคืนอ็อบเจ็กต์ analytics
ที่มีข้อมูลที่คุณได้ขอไว้ดังนี้
{ "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" }
ช่อง conversation_analytics
จะให้ข้อมูลค่าใช้จ่ายและการสนทนาสำหรับ WABA ที่เฉพาะเจาะจง เมื่อเรียกใช้ /{whatsapp-business-account-ID}?fields=conversation_analytics.{filtering-parameters}
คุณสามารถแนบพารามิเตอร์ต่อไปนี้
ชื่อ | คำอธิบาย (คลิกที่ลูกศรในคอลัมน์ด้านซ้ายเพื่อดูตัวเลือกที่รองรับ) |
---|---|
ประเภท: การประทับเวลา UNIX | จำเป็นต้องระบุ วันที่เริ่มต้นสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ |
ประเภท: ประทับเวลา UNIX | จำเป็นต้องระบุ วันที่สิ้นสุดสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ |
ประเภท: สตริง | จำเป็นต้องระบุ ความละเอียดของข้อมูลการวิเคราะห์ที่คุณต้องการเรียกดู |
ประเภท: อาร์เรย์ | ระบุหรือไม่ก็ได้ อาร์เรย์ของหมายเลขโทรศัพท์ที่คุณต้องการดึงข้อมูลการวิเคราะห์ หากไม่ได้ระบุไว้ ระบบจะใส่หมายเลขโทรศัพท์ทุกหมายเลขที่เพิ่มไว้ใน WABA ของคุณ |
| ระบุหรือไม่ก็ได้ รายการเกณฑ์ชี้วัดที่คุณต้องการรับ หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับเกณฑ์ชี้วัดทุกประเภท |
| ระบุหรือไม่ก็ได้ รายการหมวดหมู่การสนทนา หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับการสนทนาทุกหมวดหมู่ |
| ระบุหรือไม่ก็ได้ รายการของประเภทการสนทนา หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับการสนทนาทุกประเภท |
| ระบุหรือไม่ก็ได้ รายการทิศทางการสนทนา หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับทิศทางการสนทนาทั้งหมด |
| ระบุหรือไม่ก็ได้ รายการข้อมูลแยกย่อยที่คุณต้องการใช้กับเกณฑ์ชี้วัดของคุณ หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์โดยไม่มีข้อมูลแยกย่อยใดๆ |
ข้อมูลการวิเคราะห์เป็นการประมาณคร่าวๆ และอาจแตกต่างจากที่ปรากฏในใบเรียกเก็บเงิน เนื่องจากอาจมีความคลาดเคลื่อนเล็กน้อยระหว่างการประมวลผลข้อมูล
คุณสามารถรับข้อมูลการสนทนาและค่าใช้จ่ายที่เกี่ยวข้องกับ WABA ของคุณในช่วงเวลาที่กำหนดได้ คุณสามารถกรองและแยกย่อยผลลัพธ์ของคุณได้หากต้องการ ดูตัวอย่างรหัสด้านล่าง
สถานการณ์: คุณต้องการดึงข้อมูลการสนทนาและข้อมูลค่าใช้จ่ายทั้งหมดสำหรับหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABA ในเดือนที่กำหนด
โซลูชั่นที่แนะนำ:รวบรวม URL ที่คุณต้องการเรียกใช้ และรวมพารามิเตอร์การกรองต่อไปนี้
start
: จุดเริ่มต้นของช่วงเวลาของคุณ ในกรณีนี้หมายถึงวันแรกของเดือนที่คุณต้องการรับเกณฑ์ชี้วัดend
: จุดสิ้นสุดของช่วงเวลาของคุณ ในกรณีนี้หมายถึงวันสุดท้ายของเดือนที่คุณต้องการรับเกณฑ์ชี้วัดgranularity
: ความละเอียดของจุดข้อมูลที่คุณต้องการ ในตัวอย่างด้านล่าง เราใช้ MONTHLY
ดังนั้นจุดข้อมูลแต่ละรายการจึงแสดงถึงข้อมูลระยะเวลาหนึ่งเดือนphone_numbers
: ส่งอาร์เรย์ที่ว่างเปล่าและเราจะส่งคืนข้อมูลสำหรับหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABAdimensions
: ตั้งค่าเป็นข้อมูลแยกย่อยที่พร้อมใช้งานทั้งหมด ได้แก่ "CONVERSATION_CATEGORY"
, "CONVERSATION_TYPE"
, "COUNTRY"
และ "PHONE"
ในกรณีนี้ คุณไม่จำเป็นต้องระบุ country_codes
, metric_types
, conversation_types
และ conversation_categories
หากคุณไม่ระบุข้อมูลใดให้เราสำหรับช่องเหล่านั้น เราจะส่งคืนตัวเลือกที่ใช้งานได้ทั้งหมด เมื่อคุณตั้งค่า URL แล้ว ให้สร้างคำขอ 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}"
การตอบกลับที่สำเร็จจะส่งคืนอ็อบเจ็กต์ conversation_analytics
ที่มีข้อมูลที่คุณได้ขอไว้ ในตัวอย่างต่อไปนี้ WABA มีหมายเลขโทรศัพท์เพียงหมายเลขเดียวเท่านั้น
{ "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", }
สถานการณ์: คุณต้องการดึงข้อมูลการสนทนาและข้อมูลค่าใช้จ่ายทั้งหมดสำหรับหมายเลขโทรศัพท์ที่เฉพาะเจาะจงที่เกี่ยวข้องกับ WABA ในช่วงเวลาที่กำหนด ในผลลัพธ์นี้ คุณต้องการใช้ข้อมูลแยกย่อยที่เป็นไปได้ทั้งหมด คุณต้องการให้จุดข้อมูลแต่ละรายการแสดงถึงข้อมูลที่ระดับครึ่งชั่วโมง
โซลูชั่นที่แนะนำ: รวบรวม URL ที่คุณต้องการเรียกใช้ และรวมพารามิเตอร์การกรองต่อไปนี้
start
: จุดเริ่มต้นของช่วงเวลาของคุณ end
: จุดสิ้นสุดของช่วงเวลาของคุณgranularity
: ความละเอียดของจุดข้อมูลที่คุณต้องการ ในตัวอย่างด้านล่าง เราใช้ HALF_HOUR
ดังนั้นจุดข้อมูลแต่ละรายการจึงแสดงถึงข้อมูลระยะเวลาครึ่งชั่วโมงphone_numbers
: หมายเลขโทรศัพท์ที่คุณต้องการข้อมูลdimensions
: ตั้งค่าเป็นข้อมูลแยกย่อยที่พร้อมใช้งานทั้งหมด ได้แก่ CONVERSATION_CATEGORY
, CONVERSATION_TYPE
, COUNTRY
และ PHONE
ในกรณีนี้ คุณไม่จำเป็นต้องระบุ country_codes
, metric_types
, conversation_types
หรือ conversation_categories
หากคุณไม่ระบุข้อมูลใดให้เราสำหรับช่องเหล่านั้นเลย เราจะส่งคืนตัวเลือกที่ใช้งานได้ทั้งหมดให้ เมื่อคุณตั้งค่า URL แล้ว ให้สร้างคำขอ 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"
การตอบกลับที่สำเร็จจะส่งคืนอ็อบเจ็กต์ conversation_analytics
ที่มีข้อมูลที่คุณได้ขอไว้ดังนี้
{ "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" }
สถานการณ์: คุณต้องการดึงข้อมูลการสนทนาและข้อมูลค่าใช้จ่ายทั้งหมดสำหรับหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABA ในช่วงเวลาที่กำหนด คุณต้องการแยกย่อยข้อมูลในผลลัพธ์ตามประเภทการสนทนา
โซลูชั่นที่แนะนำ: รวบรวม URL ที่คุณต้องการเรียกใช้ และรวมพารามิเตอร์การกรองต่อไปนี้
start
: จุดเริ่มต้นของช่วงเวลาของคุณ end
: จุดสิ้นสุดของช่วงเวลาของคุณgranularity
: ความละเอียดของจุดข้อมูลที่คุณต้องการ ในตัวอย่างด้านล่าง เราใช้ MONTHLY
ดังนั้นจุดข้อมูลแต่ละรายการจึงแสดงถึงข้อมูลระยะเวลาครึ่งเดือนphone_numbers
: ส่งอาร์เรย์ที่ว่างเปล่าและเราจะส่งคืนข้อมูลสำหรับหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABAdimensions
: ตั้งค่าเป็น CONVERSATION_TYPE
ในกรณีนี้ คุณไม่จำเป็นต้องระบุ country_codes
, metric_types
, conversation_types
, conversation_directions
หรือ conversation_categories
หากคุณไม่ระบุข้อมูลใดให้เราสำหรับช่องเหล่านั้นเลย เราจะส่งคืนตัวเลือกที่ใช้งานได้ทั้งหมดให้ เมื่อคุณตั้งค่า URL แล้ว ให้สร้างคำขอ 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}"
การตอบกลับที่สำเร็จจะส่งคืนอ็อบเจ็กต์ conversation_analytics
ที่มีข้อมูลที่คุณได้ขอไว้ดังนี้
{ "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 } ] } ] }
คำขอ
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}"
การตอบกลับ
{ "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" }
คำขอ
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}"
การตอบกลับ
{ "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" }
การวิเคราะห์เทมเพลตจะอธิบายจำนวนครั้งที่เทมเพลตถูกส่ง ส่งถึงผู้รับ และถูกอ่าน และจำนวนครั้งที่มีการคลิกปุ่ม URL หรือปุ่มตอบกลับด่วนในเทมเพลต
ระบบจะส่งกลับข้อมูลพร้อมรายละเอียดทุกวันในเขตเวลา UTC โดยสามารถดูย้อนหลังได้สูงสุด 90 วัน คุณสามารถดูการวิเคราะห์เทมเพลตได้ในแผง ตัวจัดการ WhatsApp > เทมเพลตข้อความ > รายละเอียดเทมเพลต > ข้อมูลเชิงลึก
MARKETING
หรือ UTILITY
เท่านั้นหากต้องการรายงานจุดบกพร่องของการวิเคราะห์เทมเพลต โปรดส่งคำขอแจ้งปัญหาเพื่อขอความช่วยเหลือโดยตรง โดยเลือกรายการต่อไปนี้
คุณต้องยืนยันการวิเคราะห์เทมเพลตในบัญชี WhatsApp Business ของคุณก่อนจึงจะรับการวิเคราะห์เทมเพลตได้ คุณสามารถยืนยันการวิเคราะห์เทมเพลตได้โดยใช้ตัวจัดการ WhatsApp หรือ API หากต้องการยืนยันผ่าน API ให้ส่งคำขอต่อไปนี้:
POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>?is_enabled_for_insights=true
เมื่อได้รับการยืนยันแล้ว เราจะเริ่มบันทึกการวิเคราะห์เทมเพลตสำหรับบัญชี WhatsApp Business เมื่อยืนยันแล้ว คุณจะไม่สามารถป��ดใช้งานการวิเคราะห์เทมเพลตได้
เมื่อสำเร็จ API จะตอบกลับด้วย ID ของบัญชี WhatsApp Business ตัวอย่างเช่น
{ "id": 102290129340398 }
ชื่อ | คำอธิบาย | ค่าตัวอย่าง |
---|---|---|
ประทับเวลา UNIX | จำเป็นต้องระบุ การประทับเวลาเริ่มต้นสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ เนื่องจากการวิเคราะห์เทมเพลตมีรายละเอียดเป็นรายวันในเขตเวลา UTC การประทับเวลาเริ่มต้นนอกเหนือจาก 0:00 UTC จะได้รับการแก้ไขเป็น 0:00 UTC ก่อนหน้า |
|
ประทับเวลา UNIX | จำเป็นต้องระบุ วันที่สิ้นสุดสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ เนื่องจากการวิเคราะห์เทมเพลตมีรายละเอียดเป็นรายวันในเขตเวลา UTC การประทับเวลาสิ้นสุดนอกเหนือจาก 0:00 UTC จะได้รับการแก้ไขเป็น 0:00 UTC ถัดไป |
|
Enum | จำเป็นต้องระบุ ความละเอียดของข้อมูลการวิเคราะห์ที่คุณต้องการเรียกดู ค่าต้องเป็น |
|
อาร์เรย์ของ ID | จำเป็นต้องระบุ อาร์เรย์ของ ID เทมเพลตที่คุณต้องการดึงข้อมูลการวิเคราะห์ จำนวนสูงสุดคือ 10 |
|
อาร์เรย์ของ enum | ระบุหรือไม่ก็ได้ โหนด ประเภทของเกณฑ์ชี้วัดที่คุณต้องการดึงข้อมูล หากมีการละเว้นอาร์เรย์หรืออาร์เรย์ว่างเปล่า ระบบจะส่งคืนการวิเคราะห์สำหรับประเภทเกณฑ์ชี้วัดทั้งหมด ค่าที่เป็นไปได้
ระบบจะส่งกลับการคลิกสำหรับปุ่ม URL และปุ่มตอบกลับด่วนในเทมเพลตที่จัดหมวดหมู่เป็น ระบบจะส่งกลับเกณฑ์ชี้วัดต้นทุนในรูปแบบของอาร์เรย์อ็อบเจ็กต์ต้นทุน พร้อมประเภทและค่าของแต่ละรายการ ประเภทอาจเป็นรายการดังต่อไปนี้
|
|
สถานการณ์: อิงจากกรอบเวลา 1 วัน คุณสามารถรับประเภทเกณฑ์ชี้วัดการวิเคราะห์เทมเพลตทั้งหมดสำหรับเทมเพลตการยืนยันตัวตนและเทมเพลตการตลาดที่มีปุ่ม URL ได้
ตัวอย่างคำขอ
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...'
ตัวอย่างการตอบกลับ
{ "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" } } }
คุณสามารถปิดใช้งานการติดตามการคลิกปุ่มในแต่ละเทมเพลตได้โดยการตั้งค่าช่อง cta_url_link_tracking_opted_out
เป็น true
เมื่อปิดใช้งานแล้ว API จะไม่ส่งคืนคุณสมบัติที่ถูกคลิกในการวิเคราะห์เทมเพลตหรือการแสดงการมีส่วนร่วม/การคลิกปุ่มในตัวจัดการ WhatsApp อีกต่อไปเมื่อดูข้อมูลเชิงลึกของเทมเพลต
POST /<TEMPLATE_ID> ?cta_url_link_tracking_opted_out=<OPT_OUT> &category=<TEMPLATE_CATEGORY>
ตัวยึดตำแหน่ง | คำอธิบาย | ค่าตัวอย่าง |
---|---|---|
ID เทมเพลต | จำเป็นต้องระบุ ID เทมเพลต |
|
บูลีน | จำเป็นต้องระบุ บ่งชี้ว่าการติดตามการคลิกปุ่มเทมเพลตถูกปิดใช้งานหรือไม่ ตั้งเป็น ค่านี้จะถูกตั้งเป็น |
|
สตริง | จำเป็นต้องระบุ หมวดหมู่ปัจจุบันของเทมเพลต หากคุณตั้งค่าหมวดหมู่เทมเพลตเป็นค่าอื่นที่ไม่ใช่หมวดหมู่ปัจจุบัน สถานะเทมเพลตจะถูกตั้งค่าเป็น |
|
curl -X POST 'https://graph.facebook.com/v20.0
/245435364965041?cta_url_link_tracking_opted_out=true&category=marketing' \
-H 'Authorization: Bearer EAAJB...'
เมื่อดำเนินการสำเร็จ API จะตอบกลับดังต่อไปนี้
{ "success": true }
โปรดดูรายการค่าที่เป็นไปได้ทั้งหมดสำหรับแต่ละช่องในข้อมูลอ้างอิงเกี่ยวกับ API กราฟของช่องการวิเคราะห์บัญชี WhatsApp Business