การวิเคราะห์

เอกสารนี้จะอธิบายวิธีเรียกดูข้อความ การสนทนา และการวิเคราะห์เทมเพลต เช่น จำนวนข้อความที่ส่งจากหมายเลขโทรศัพท์ของธุรกิจ จำนวนการสนทนา และค่าใช้จ่ายสำหรับบัญชี WhatsApp Business (WABA) หรือจำนวนครั้งที่มีการอ่านเทมเพลตที่กำหนด

เฉพาะเกณฑ์ชี้วัดสำหรับหมายเลขโทรศัพท์ธุรกิจและเทมเพลตที่เชื่อมโยงกับ WABA ของคุณ ณ เวลาที่ร้องขอเท่านั้นที่จะถูกรวมไว้ในการตอบกลับ

การรับข้อมูล

ใช้ตำแหน่งข้อมูลบัญชี WhatsApp Business เพื่อรับการวิเคราะห์

รูปแบบคำสั่งของการสืบค้น

GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>
  ?fields=<FIELDS>.<FILTERING_PARAMETER>

พารามิเตอร์สตริงการสืบค้น

ตัวยึดตำแหน่งคำอธิบายค่าตัวอย่าง

<FIELDS>

จำเป็นต้องระบุ


เกณฑ์ชี้วัด ค่าอาจเป็นหนึ่งในรายการต่อไปนี้


analytics

<FILTERING_PARAMETERS>

จำเป็นต้องระบุ


พารามิเตอร์การกรองเกณฑ์ชี้วัด เพิ่มพารามิเตอร์การกรองเพิ่มเติมโดยใช้จุด


สำหรับค่าที่เป็นไปได้ ให้ดูที่


.start(1543543200).end(1544148000).granularity(DAY)

การวิเคราะห์การส่งข้อความ

ช่อง analytics จะให้จำนวนและประเภทของข้อความที่ส่งออกและส่งถึงผู้รับโดยหมายเลขโทรศัพท์ที่เกี่ยวข้องกับ WABA ที่เฉพาะเจาะจง หากต้องการข้อมูลเกี่ยวกับเกณฑ์ชี้วัดการสนทนา โปรดดูการวิเคราะห์การสนทนา เมื่อเรียกใช้ /{whatsapp-business-account-ID}?fields=analytics.{filtering-parameters} คุณสามารถแนบพารามิเตอร์ต่อไปนี้

พารามิเตอร์การวิเคราะห์

ชื่อคำอธิบาย (คลิกที่ลูกศรในคอลัมน์ด้านซ้ายเพื่อดูตัวเลือกที่รองรับ)

start

ประเภท: การประทับเวลา UNIX

จำเป็นต้องระบุ

วันที่เริ่มต้นสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์

end

ประเภท: ประทับเวลา UNIX

จำเป็นต้องระบุ

วันที่สิ้นสุดสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์

granularity

ประเภท: สตริง

จำเป็นต้องระบุ

ความละเอียดของข้อมูลการวิเคราะห์ที่คุณต้องการเรียกดู

ตัวเลือกที่รองรับ

  • HALF_HOUR
  • DAY
  • MONTH

phone_numbers

ประเภท: อาร์เรย์

ระบุหรือไม่ก็ได้

อาร์เรย์ของหมายเลขโทรศัพท์ที่คุณต้องการดึงข้อมูลการวิเคราะห์ หากไม่ได้ระบุไว้ ระบบจะใส่หมายเลขโทรศัพท์ทุกหมายเลขที่เพิ่มไว้กับ WABA ของคุณ

product_types

ประเภท: อาร์เรย์

ระบุหรือไม่ก็ได้

ประเภทของข้อความ (ข้อความแจ้งเตือนและ/หรือข้อความฝ่ายบริการลูกค้า) ซึ่งคุณต้องการดึงข้อมูลการแจ้งเตือน ระบุอาร์เรย์และรวม 0 สำหรับข้อความแจ้งเตือน และ 2 สำหรับข้อความฝ่ายบริการลูกค้าเข้าไปด้วย หากไม่ได้ระบุไว้ จะมีการส่งคืนการวิเคราะห์สำหรับข้อความทั้งหมดพร้อมกัน

country_codes

ประเภท: อาร์เรย์

ระบุหรือไม่ก็ได้

ประเทศที่คุณต้องการดึงข้อมูลการวิเคราะห์ ระบุอาร์เรย์พร้อมรหัสประเทศ 2 ตัวอักษรสำหรับประเทศที่คุณต้องการใส่ หากไม่ได้ระบุไว้ ระบบจะส่งคืนการวิเคราะห์สำหรับทุกประเทศที่คุณติดต่อสื่อสารด้วย

ตัวอย่าง

สถานการณ์: คุณต้องการรับจำนวนข้อความที่ส่งออกและส่งถึงผู้รับโดยหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABA ของคุณ

โซลูชั่นที่แนะนำ:รวบรวม URL ที่คุณต้องการเรียกใช้ และรวมพารามิเตอร์การกรองต่อไปนี้เข้าไปด้วย: start, end, granularity จากนั้น ให้ส่งคำขอ GET ไปยัง URL ดังกล่าว ดังนี้

curl -i -X GET \ 
"https://graph.facebook.com/v19.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} คุณสามารถแนบพารามิเตอร์ต่อไปนี้

พารามิเตอร์การวิเคราะห์การสนทนา

ชื่อคำอธิบาย (คลิกที่ลูกศรในคอลัมน์ด้านซ้ายเพื่อดูตัวเลือกที่รองรับ)

start

ประเภท: การประทับเวลา UNIX

จำเป็นต้องระบุ

วันที่เริ่มต้นสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์

end

ประเภท: ประทับเวลา UNIX

จำเป็นต้องระบุ

วันที่สิ้นสุดสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์

granularity

ประเภท: สตริง

จำเป็นต้องระบุ

ความละเอียดของข้อมูลการวิเคราะห์ที่คุณต้องการเรียกดู

ตัวเลือกที่รองรับ

  • HALF_HOUR
  • DAILY
  • MONTHLY

phone_numbers

ประเภท: อาร์เรย์

ระบุหรือไม่ก็ได้

อาร์เรย์ของหมายเลขโทรศัพท์ที่คุณต้องการดึงข้อมูลการวิเคราะห์ หากไม่ได้ระบุไว้ ระบบจะใส่หมายเลขโทรศัพท์ทุกหมายเลขที่เพิ่มไว้ใน WABA ของคุณ

metric_types

ระบุหรือไม่ก็ได้

รายการเกณฑ์ชี้วัดที่คุณต้องการรับ หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับเกณฑ์ชี้วัดทุกประเภท

ตัวเลือกที่รองรับ {#ที่รองรับ}

  • COST: รวมค่าบริการโดยประมาณสำหรับช่วงเวลานั้นๆ ในสกุลเงินของ WABA
  • CONVERSATION: รวมจำนวนการสนทนาสำหรับช่วงเวลานั้นๆ

ตั้งแต่วันที่ 1 กรกฎาคม 2023 ระบบจะไม่แสดง COST สำหรับธุรกิจที่เรียกเก็บเงินผ่านพาร์ทเนอร์โซลูชั่นอีกต่อไป โปรดติดต่อพาร์ทเนอร์ของคุณเพื่อทำความเข้าใจเกี่ยวกับค่าบริการ หากคุณเรียกเก็บเงินผ่านพาร์ทเนอร์ ลักษณะการทำงานที่จะเกิดขึ้นเป็นดังนี้

  1. หากไม่ได้ระบุ metric_types ไว้ในคำขอของคุณ ระบบจะส่งคืน CONVERSATION เท่านั้น
  2. หากระบุเพียง CONVERSATION ระบบจะส่งคืน CONVERSATION เท่านั้น
  3. หากระบุเพียง COST ระบบจะส่งคืนข้อยกเว้นต่อไปนี้
    • ชื่อ: “Cost not available” (ค่าใช้จ่ายไม่พร้อมให้บริการ)
    • ข้อความ: “Cost is no longer shown for businesses who bill through a partner (i.e., BSP). To understand your charges, please reach out to your partner.” (ระบบจะไม่แสดงค่าใช้จ่ายสำหรับธุรกิจที่เรียกเก็บเงินผ่านพาร์ทเนอร์ (กล่าวคือ BSP) อีกต่อไป โปรดติดต่อพาร์ทเนอร์ของคุณเพื่อทำความเข้าใจเกี่ยวกับค่าบริการของคุณ)

หากคุณสืบค้นช่วงเวลาที่มีวันที่ 1 กรกฎาคม 2023 เป็นต้นไปรวมอยู่ด้วย (เช่น วันที่ 1 พฤษภาคม 2023 ถึง 1 สิงหาคม 2023) การตอบกลับก็จะมีข้อยกเว้นข้างต้นรวมอยู่ด้วย

จะไม่มีการเปลี่ยนแปลงสำหรับพาร์ทเนอร์เมื่อสืบค้นตำแหน่งข้อมูล conversation_analytics

conversation_categories

ระบุหรือไม่ก็ได้

รายการหมวดหมู่การสนทนา หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับการสนทนาทุกหมวดหมู่

ตัวเลือกที่รองรับ

  • AUTHENTICATION
  • MARKETING
  • SERVICE
  • UTILITY

conversation_types

ระบุหรือไม่ก็ได้

รายการของประเภทการสนทนา หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับการสนทนาทุกประเภท

ตัวเลือกที่รองรับ

conversation_directions

ระบุหรือไม่ก็ได้

รายการทิศทางการสนทนา หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์สำหรับทิศทางการสนทนาทั้งหมด

ตัวเลือกที่รองรับ

  • BUSINESS_INITIATED: การสนทนาที่เริ่มโดยธุรกิจ
  • USER_INITIATED: การสนทนาที่เริ่มโดยผู้ใช้ปลายทาง/ลูกค้า

dimensions

ระบุหรือไม่ก็ได้

รายการข้อมูลแยกย่อยที่คุณต้องการใช้กับเกณฑ์ชี้วัดของคุณ หากคุณส่งรายการที่ว่างเปล่า เราจะส่งคืนผลลัพธ์โดยไม่มีข้อมูลแยกย่อยใดๆ

ตัวเลือกที่รองรับ

  • CONVERSATION_CATEGORY
  • CONVERSATION_DIRECTION
  • CONVERSATION_TYPE
  • COUNTRY
  • PHONE

ข้อมูลการวิเคราะห์เป็นการประมาณคร่าวๆ และอาจแตกต่างจากที่ปรากฏในใบเรียกเก็บเงิน เนื่องจากอาจมีความคลาดเคลื่อนเล็กน้อยระหว่างการประมวลผลข้อมูล

ตัวอย่าง

คุณสามารถรับข้อมูลการสนทนาและค่าใช้จ่ายที่เกี่ยวข้องกับ WABA ของคุณในช่วงเวลาที่กำหนดได้ คุณสามารถกรองและแยกย่อยผลลัพธ์ของคุณได้หากต้องการ ดูตัวอย่างรหัสด้านล่าง

การรับข้อมูลรายเดือนโดยใช้ข้อมูลแยกย่อยทั้งหมด

สถานการณ์: คุณต้องการดึงข้อมูลการสนทนาและข้อมูลค่าใช้จ่ายทั้งหมดสำหรับหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABA ในเดือนที่กำหนด

โซลูชั่นที่แนะนำ:รวบรวม URL ที่คุณต้องการเรียกใช้ และรวมพารามิเตอร์การกรองต่อไปนี้

  • start: จุดเริ่มต้นของช่วงเวลาของคุณ ในกรณีนี้หมายถึงวันแรกของเดือนที่คุณต้องการรับเกณฑ์ชี้วัด
  • end: จุดสิ้นสุดของช่วงเวลาของคุณ ในกรณีนี้หมายถึงวันสุดท้ายของเดือนที่คุณต้องการรับเกณฑ์ชี้วัด
  • granularity: ความละเอียดของจุดข้อมูลที่คุณต้องการ ในตัวอย่างด้านล่าง เราใช้ MONTHLY ดังนั้นจุดข้อมูลแต่ละรายการจึงแสดงถึงข้อมูลระยะเวลาหนึ่งเดือน
  • phone_numbers: ส่งอาร์เรย์ที่ว่างเปล่าและเราจะส่งคืนข้อมูลสำหรับหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABA
  • 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/v19.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/v19.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: ส่งอาร์เรย์ที่ว่างเปล่าและเราจะส่งคืนข้อมูลสำหรับหมายเลขโทรศัพท์ทั้งหมดที่เกี่ยวข้องกับ WABA
  • dimensions: ตั้งค่าเป็น CONVERSATION_TYPE

ในกรณีนี้ คุณไม่จำเป็นต้องระบุ country_codes, metric_types, conversation_types, conversation_directions หรือ conversation_categories หากคุณไม่ระบุข้อมูลใดให้เราสำหรับช่องเหล่านั้น เราจะส่งคืนตัวเลือกที่ใช้งานได้ทั้งหมดให้ เมื่อคุณตั้งค่า URL แล้ว ให้สร้างคำขอ GET ดังนี้

curl -i -X GET
"https://graph.facebook.com/v19.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/v19.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/v19.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 > เทมเพลตข้อความ > รายละเอียดเทมเพลต > ข้อมูลเชิงลึก

ข้อจำกัด

  • การวิเคราะห์เทมเพลตใช้ได้เฉพาะกับ API ภายในองค์กร หากบัญชีไม่ได้เลือกรับการวิเคราะห์เทมเพลตสำหรับ API ระบบคลาวด์
  • การวิเคราะห์เทมเพลตสำหรับ API ภายในองค์กรอยู่ภายใต้แนวทางการรวมและการลบข้อมูลระบุตัวตน ซึ่งกำหนดให้ต้องมีเหตุการณ์อย่างน้อย 1,000 เหตุการณ์ก่อนที่จะแสดงจำนวนให้ผู้ใช้เห็น
  • การวิเคราะห์การคลิกปุ่มจะใช้ได้กับเทมเพลตที่ได้รับการจัดหมวดหมู่เป็น MARKETING หรือ UTILITY เท่านั้น
  • WABA ที่เป็นของหรือใช้ร่วมกันกับบัญชีธุรกิจ Meta ในสหภาพยุโรป สหราชอาณาจักร และญี่ปุ่น หรือที่มีหมายเลขโทรศัพท์ธุรกิจพร้อมรหัสการโทรของประเทศจากประเทศหรือภูมิภาคเหล่านี้จะไม่สามารถใช้ได้

การรายงานจุดบกพร่อง

หากต้องการรายงานจุดบกพร่องของการวิเคราะห์เทมเพลต โปรดส่งคำขอแจ้งปัญหาเพื่อขอความช่วยเหลือโดยตรง โดยเลือกรายการต่อไปนี้

  • หัวข้อคำถาม: WABiz: Cloud API
  • ประเภทคำขอ: จุดบกพร่องหรือหรือปัญหาการใช้งาน

การยืนยันการวิเคราะห์เทมเพลต

คุณต้องยืนยันการวิเคราะห์เทมเพลตในบัญชี WhatsApp Business ของคุณก่อนจึงจะรับการวิเคราะห์เทมเพลตได้ คุณสามารถยืนยันการวิเคราะห์เทมเพลตได้โดยใช้ตัวจัดการ WhatsApp หรือ API หากต้องการยืนยันผ่าน API ให้ส่งคำขอต่อไปนี้:

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>?is_enabled_for_insights=true

เมื่อได้รับการยืนยันแล้ว เราจะเริ่มบันทึกการวิเคราะห์เทมเพลตสำหรับบัญชี WhatsApp Business เมื่อยืนยันแล้ว คุณจะไม่สามารถปิดใช้งานการวิเคราะห์เทมเพลตได้

เมื่อสำเร็จ API จะตอบกลับด้วย ID ของบัญชี WhatsApp Business ตัวอย่างเช่น:

{                          
  "id": 102290129340398
}

พารามิเตอร์การวิเคราะห์เทมเพลต

ชื่อคำอธิบายค่าตัวอย่าง

start

ประทับเวลา UNIX

จำเป็นต้องระบุ


การประทับเวลาเริ่มต้นสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ เนื่องจากการวิเคราะห์เทมเพลตมีรายละเอียดเป็นรายวันในเขตเวลา UTC การประทับเวลาเริ่มต้นนอกเหนือจาก 0:00 UTC จะได้รับการแก้ไขเป็น 0:00 UTC ก่อนหน้า

1543536000

end

ประทับเวลา UNIX

จำเป็นต้องระบุ


วันที่สิ้นสุดสำหรับช่วงวันที่ที่คุณกำลังดึงข้อมูลการวิเคราะห์ เนื่องจากการวิเคราะห์เทมเพลตมีรายละเอียดเป็นรายวันในเขตเวลา UTC การประทับเวลาสิ้นสุดนอกเหนือจาก 0:00 UTC จะได้รับการแก้ไขเป็น 0:00 UTC ถัดไป

1543708800

granularity

Enum

จำเป็นต้องระบุ


ความละเอียดของข้อมูลการวิเคราะห์ที่คุณต้องการดึง ค่าที่รองรับ ได้แก่


  • DAILY

DAILY

template_ids

อาร์เรย์ของ ID

จำเป็นต้องระบุ


อาร์เรย์ของ ID เทมเพลตที่คุณต้องการดึงข้อมูลการวิเคราะห์


จำนวนสูงสุดคือ 10

[1924084211297547,954638012257287,969725530748535]

metric_types

อาร์เรย์ของ enum

ระบุหรือไม่ก็ได้


ประเภทของเกณฑ์ชี้วัดที่คุณต้องการดึงข้อมูล หากมีการละเว้นอาร์เรย์หรืออาร์เรย์ว่างเปล่า ระบบจะส่งคืนการวิเคราะห์สำหรับประเภทเกณฑ์ชี้วัดทั้งหมด


ค่าที่เป็นไปได้:


  • CLICKED
  • DELIVERED
  • READ
  • SENT

ระบบจะส่งกลับการคลิกสำหรับปุ่ม URL และปุ่มตอบกลับด่วนในเทมเพลตที่จัดหมวดหมู่เป็น MARKETING หรือ UTILITY

["SENT","DELIVERED","READ"]

ตัวอย่าง

รับการวิเคราะห์เทมเพลตทั้งหมด

สถานการณ์: คุณต้องการรับการวิเคราะห์เทมเพลตที่มีอยู่ทั้งหมดสำหรับเทมเพลตข้อความเดียวที่เชื่อมโยงกับบัญชี WhatsApp Business ภายในระยะเวลา 2 วัน

ตัวอย่างคำขอ

curl -g 'https://graph.facebook.com/v19.0/109259195336416/template_analytics?start=1689379200&end=1689552000&granularity=DAILY&metric_types=[%27SENT%27%2C%27DELIVERED%27%2C%27READ%27%2C%27CLICKED%27]&template_ids=[1924084211297547%2C954638012257287]' \
-H 'Authorization: Bearer EABN8...'

ตัวอย่างการตอบกลับ:

{
  "data": [
    {
      "granularity": "DAILY",
      "data_points": [
        {
          "template_id": "1924084211297547",
          "start": 1689379200,
          "end": 1689465600,
          "sent": 0,
          "delivered": 0,
          "read": 0,
          "clicked": [
            {
              "type": "quick_reply_button",
              "button_content": "Tell me more",
              "count": 3
            },
            {
              "type": "quick_reply_button",
              "button_content": "Get coupon",
              "count": 5
            }
          ]
        },
        {
          "template_id": "1924084211297547",
          "start": 1689465600,
          "end": 1689552000,
          "sent": 0,
          "delivered": 0,
          "read": 0,
          "clicked": [
            {
              "type": "quick_reply_button",
              "button_content": "Tell me more",
              "count": 73
            },
            {
              "type": "quick_reply_button",
              "button_content": "Get coupon",
              "count": 35
            }
          ]
        },
        {
          "template_id": "954638012257287",
          "start": 1689379200,
          "end": 1689465600,
          "sent": 0,
          "delivered": 0,
          "read": 0,
          "clicked": [
            {
              "type": "url_button",
              "button_content": "Visit Website",
              "count": 13
            }
          ]
        },
        {
          "template_id": "954638012257287",
          "start": 1689465600,
          "end": 1689552000,
          "sent": 0,
          "delivered": 0,
          "read": 0,
          "clicked": [
            {
              "type": "url_button",
              "button_content": "Visit Website",
              "count": 12
            }
          ]
        }
      ]
    }
  ],
  "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>

พารามิเตอร์การส่งคำขอ

ตัวยึดตำแหน่งคำอธิบายค่าตัวอย่าง

<WHATSAPP_TEMPLATE_ID>

ID เทมเพลต

จำเป็นต้องระบุ


ID เทมเพลต

245435364965041

<OPT_OUT>

บูลีน

จำเป็นต้องระบุ


บ่งชี้ว่าการติดตามการคลิกปุ่มเทมเพลตถูกปิดใช้งานหรือไม่ ตั้งเป็น true เพื่อปิดใช้งานการติดตามการคลิกปุ่มหรือ false เพื่อเปิดใช้งาน


ค่านี้จะถูกตั้งเป็น false เมื่อมีการสร้างเทมเพลต

true

<TEMPLATE_CATEGORY>

สตริง

จำเป็นต้องระบุ


หมวดหมู่ปัจจุบันของเทมเพลต


หากคุณตั้งค่าหมวดหมู่เทมเพลตเป็นค่าอื่นที่ไม่ใช่หมวดหมู่ปัจจุบัน สถานะเทมเพลตจะถูกตั้งค่าเป็น PENDING และเทมเพลตจะต้องได้รับการตรวจสอบเทมเพลตจึงจะได้รับการอนุมัติ

marketing

ตัวอย่างคำขอ

curl -X POST 'https://graph.facebook.com/v19.0/245435364965041?cta_url_link_tracking_opted_out=true&category=marketing' \
-H 'Authorization: Bearer EAAJB...'

ตัวอย่างการตอบกลับ

เมื่อดำเนินการสำเร็จ API จะตอบกลับดังต่อไปนี้

{
    "success": true
}

ข้อมูลอ้างอิง

โปรดดูรายการค่าที่เป็นไปได้ทั้งหมดสำหรับแต่ละช่องในข้อมูลอ้างอิงเกี่ยวกับ API กราฟของช่องการวิเคราะห์บัญชี WhatsApp Business