API Thông tin chi tiết nhắn tin

Tài liệu này giải thích cách lấy số liệu theo lập trình về các tin nhắn mà doanh nghiệp bạn đã gửi hoặc nhận. API Thông tin chi tiết nhắn tin là phần mở rộng của API Thông tin chi tiết Trang để bạn xem được thông tin như thông tin hiển thị trong tab Thông tin chi tiết Trang của Trang Facebook.

Trước khi bạn bắt đầu

Hướng dẫn này giả định rằng bạn đã đọc phần Tổng quan về nền tảng Messenger, cũng như triển khai các thành phần cần thiết để gửi/nhận tin nhắn và thông báo.

Để xem số liệu cho Trang Facebook mà bạn sở hữu hoặc có thể thực hiện tác vụ ANALYZE, ứng dụng của bạn sẽ cần:

  • ID Trang cho Trang Facebook mà bạn muốn xem số liệu
    • Đối với tin nhắn trên Instagram, đây sẽ là Trang Facebook liên kết với tài khoản Công việc trên Instagram
  • Mã truy cập Trang
  • Những quyền dưới đây:
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • Quyền truy cập tiêu chuẩn

Để xem số liệu cho Trang Facebook mà bạn không sở hữu hoặc không thể thực hiện tác vụ ANALYZE, ứng dụng của bạn sẽ cần:

  • ID Trang cho Trang Facebook mà bạn muốn xem số liệu
    • Đối với tin nhắn trên Instagram, đây sẽ là Trang Facebook liên kết với tài khoản Công việc trên Instagram
  • Mã truy cập Trang do một người có thể thực hiện tác vụ ANALYZE trên Trang đó yêu cầu
  • Các quyền sau thông qua phương thức Đăng nhập bằng Facebook:
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • Quyền truy cập nâng cao

Các giới hạn

  • Để cuộc trò chuyện mới được tính, người dùng phải thực hiện một hành động, chẳng hạn như trả lời doanh nghiệp bạn. Nếu người dùng chưa thực hiện hành động nào, cuộc trò chuyện đó sẽ chỉ hiển thị với họ và không được tính.

Đọc các số liệu trong Thông tin chi tiết

Để đọc thông tin dành cho một hoặc nhiều số liệu, hãy gửi yêu cầu GET đến điểm cuối /PAGE-ID/insights với thông số metric được đặt là danh sách số liệu bạn muốn xem, được phân tách bằng dấu phẩy.

Yêu cầu mẫu

Được định dạng để dễ đọc.
curl -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights
    ?metric=page_messages_new_conversations_unique,page_messages_blocked_conversations_unique 
    &access_token=PAGE-ACCESS-TOKEN"

Nếu thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON sau đây:

{ 
  "data": [ 
    { 
      "name": "page_messages_new_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "42", 
          "end_time": "1665175977" 
        }, 
      ]
    },
    { 
      "name": "page_messages_blocked_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "0", 
          "end_time": "1665175977" 
        }, 
      ]
    } 
  ],
}

Yêu cầu mẫu về tổng theo khoảng

Ví dụ sau đây cho biết tổng số lượt chuyển đổi mới, không trùng lặp trong một khoảng thời gian cụ thể bằng cách thêm thông số period được đặt là total_over_range có khoảng thời gian được xác định bằng các thông số sinceuntil trong lệnh gọi API của chúng tôi.

Được định dạng để dễ đọc.
curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=page_messages_new_conversations_unique
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &access_token=PAGE-ACCESS-TOKEN"

Nếu thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON sau, kèm số lượng cuộc trò chuyện mới, không trùng lặp vào cuối khoảng thời gian:

{
  "data": [
    {
      "name": "page_messages_new_conversations_unique",
      "period": "total_over_range",
      "values": [
        {
          "value": 27
          "end_time": "1665175977"
        }
      ],
    }
  ]
}

Yêu cầu mẫu về số liệu chia nhỏ

Ví dụ sau đây cho biết tổng số mã thông báo định kỳ trong khoảng thời gian cụ thể, được phân nhóm theo chủ đề và tần suất.

curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=recurring_notifications_tokens   
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &breakdown=recurring_notifications_topic,recurring_notifications_frequency 
    &access_token=PAGE-ACCESS-TOKEN"

Nếu thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON sau đây, kèm mã được nhóm theo chủ đề - "newproducts" và "10percentsale", cùng với tần suất nhắn tin cho từng chủ đề - "daily", "weekly" và "monthly" dành cho "newproducts" và "daily" và "weekly" dành cho "10percentsale":

{
  "data": [
    {
      "name": "recurring_notifications_tokens",
      "period": "total_over_range",
      "values": [ 
        {
          "value": 3,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 15,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "weekly"
        },
        {
          "value": 8,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "monthly"
        },
        {
          "value": 17,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 14,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "weekly"
        },
      ]
    }
  ]
}

Thông số Thông tin chi tiết

Thông số Mô tả

breakdown

Kích thước nhóm phản hồi. Có thể là một hoặc nhiều giá trị sau:

TênMô tả

campaign_id

Xem dữ liệu theo số ID chiến dịch. Ví dụ: "abc123", "Chiến dịch nhắn tin mùa hè" và "Khuyến mãi mùa xuân 2"

engagement_source

Xem dữ liệu theo loại tương tác với thông báo định kỳ. Ví dụ: ID CTA chính và phụ (CTA được nhấp vào)

message_type

Xem dữ liệu theo loại tin nhắn mà doanh nghiệp bạn đã gửi. Ví dụ: tin nhắn Marketing

messaging_channel

Xem dữ liệu theo kênh được dùng để phân phối tin nhắn đến người dùng. Ví dụ: Messenger và Instagram

recurring_notifications_entry_point

Xem dữ liệu theo điểm truy cập thông báo định kỳ. Ví dụ: Trong chuỗi trò chuyện, Plugin chat, quảng cáo CTM, plugin Ô để đánh dấu, liên kết m.me hoặc ig.me và Trang Facebook

recurring_notifications_frequency

Xem dữ liệu theo tần suất đã cho phép khi chọn nhận thông báo định kỳ. Ví dụ: Hàng ngày, Hàng tuần và Hàng tháng

recurring_notifications_topic

Xem dữ liệu theo chủ đề của thông báo định kỳ. Ví dụ: Tin nhắn quảng cáo, Ra mắt sản phẩm và Ưu đãi

date_preset

Khoảng ngày tương đối có thể dùng thay cho sinceuntil. Có thể là last_week, last_month, last_quarter, v.v. Xem thêm giá trị trong hướng dẫn về Thông tin chi tiết Trang.

metric

Bắt buộc.Danh sách số liệu sẽ trả về, được phân tách bằng dấu phẩy

period

Khoảng thời gian tổng hợp được cung cấp trong khoảng since/until hoặc date_preset. Giá trị total_over_range cung cấp một giá trị duy nhất cho số liệu trong khoảng ngày cụ thể. Có thể là day, week, month, days_28 hoặc total_over_range.

since

Ngày bắt đầu của khoảng ngày mà bạn muốn xem dữ liệu. Bao gồm dữ liệu cho nhóm ngày bắt đầu vào lúc 00:00. Giá trị có định dạng YYYY-MM-DD. Giá trị 2022-01-31 sẽ cung cấp dữ liệu từ 00:00 ngày 31/01/2022.

until

Ngày kết thúc của khoảng ngày mà bạn muốn xem dữ liệu. Không bao gồm dữ liệu cho nhóm ngày bắt đầu vào lúc 00:00. Giá trị có định dạng YYYY-MM-DD. Giá trị 2022-02-01 sẽ cung cấp dữ liệu đến 23:59 ngày 31/01/2022.

Số liệu có sẵn

Bạn có thể lấy các số liệu sau qua API Thông tin chi tiết nhắn tin:

Tên metricMô tả

page_messages_blocked_conversations_unique

Số cuộc trò chuyện với Trang đã bị chặn.

page_messages_engagement

Số lần khách hàng tương tác với tin nhắn marketing trên Trang kinh doanh của bạn, bằng cách nhấn vào nút kêu gọi hành động.

Giá trị có thể sử dụng cho breakdown:

  • campaign_id
  • engagement_source
  • message_type
  • messaging_channel
  • recurring_notifications_topic

Đây là số liệu đang phát triển.

page_messages_new_conversations_unique

Số cuộc trò chuyện qua tin nhắn trên Messenger bắt đầu với người trước đây chưa từng nhắn tin với doanh nghiệp bạn.

page_messages_order_count

Số lần bạn tạo đơn đặt hàng trong cuộc trò chuyện qua tin nhắn hoặc trong ứng dụng/trang web bên thứ ba dùng để quản lý cuộc trò chuyện qua tin nhắn.


Đây là số liệu đang phát triển.

page_messages_paid_order_earnings

Số tiền ước tính bạn kiếm được từ đơn đặt hàng đã tạo trong cuộc trò chuyện qua tin nhắn hoặc ứng dụng/trang web bên thứ ba dùng để quản lý cuộc trò chuyện qua tin nhắn. Thu nhập cuối cùng có thể chênh lệch do quy đổi tiền tệ.


Đây là số liệu đang phát triển.

page_messages_read_ratio

Số tin nhắn marketing đã đọc chia cho số tin nhắn marketing mà Trang của bạn đã gửi.

Một số lượt đọc tin nhắn có thể không được ghi lại, chẳng hạn như khi khách hàng tắt thông báo đã đọc.

Giá trị có thể sử dụng cho breakdown:

  • campaign_id
  • message_type
  • messaging_channel
  • recurring_notifications_topic

Đây là số liệu đang phát triển.

page_messages_reported_conversations_unique

Số cuộc trò chuyện từ Trang đã bị mọi người báo cáo vì các lý do như spam hoặc chứa nội dung không phù hợp.

page_messages_sent

Số tin nhắn marketing mà Trang kinh doanh của bạn đã gửi cho khách hàng.


Giá trị có thể sử dụng cho breakdown:

  • campaign_id
  • messsage_type
  • messaging_channel
  • recurring_notifications_topic

Đây là số liệu đang phát triển.

page_messages_total_messaging_connections

Số người doanh nghiệp của bạn có thể gửi tin nhắn.


Số liệu này thể hiện số người đã từng gửi tin nhắn cho doanh nghiệp của bạn trên Messenger, ngoại trừ những người đã chặn hoặc báo cáo doanh nghiệp của bạn trên Messenger. Có thể có một số hạn chế về khả năng gửi tin nhắn đến các quan hệ kết nối của bạn, chẳng hạn như giới hạn số lượng tin nhắn bạn có thể gửi trong những khung thời gian nhất định. Số liệu này cũng chỉ bao gồm các quan hệ kết nối được thiết lập từ tháng 10/2016, khi dữ liệu có sẵn.

page_messages_with_business_outcomes

Số người kết nối qua tin nhắn đã tạo ít nhất một đơn đặt hàng.


Đây là số liệu đang phát triển.

recurring_notifications_tokens

Số lần một tài khoản đã đăng ký nhận tin nhắn marketing của doanh nghiệp bạn. Nếu đăng ký nhiều chủ đề, tài khoản đó sẽ được tính một lần nữa cho từng chủ đề.


Cách tính: Số liệu này được tính bằng cách lấy số lần tài khoản đồng ý nhận tin nhắn định kỳ trừ đi số lần tài khoản hủy đăng ký.


Giá trị có thể sử dụng cho breakdown:

  • messaging_channel
  • recurring_notifications_frequency
  • recurring_notifications_topic

Đây là số liệu đang phát triển.

Tìm hiểu thêm về số liệu đang phát triển.

Thuộc tính phản hồi

Hệ thống có thể trả về các thông tin sau trong lệnh gọi đến API Thông tin chi tiết.

Thuộc tính Mô tả

data

mảng đối tượng

Danh sách các đối tượng của số liệu

name
chuỗi

Tên số liệu

period
chuỗi

Khoảng thời gian báo cáo dữ liệu

values
mảng đối tượng

Danh sách dữ liệu cho một số liệu.

value
int

Tổng số cho số liệu được yêu cầu trong khoảng ngày xác định

end_time
nhãn thời gian unix

Nhãn thời gian UTC của thời gian kết thúc lấy số liệu