圖文分析資料介面
圖文分析資料介面
微信公眾平台於2015年1月6日啟動了資料介面的邀請內測。透過數據接口，開發者可以獲得與公眾平台官網統計模組類似但更靈活的數據，還可根據需要進行高級處理。
在公眾號登入授權機制的權限集分割中，圖文分析資料介面屬於群發與通知權限。
向所有公眾號開發者開放資料介面的時間將另行通知。
請注意：
1、接口侧的公众号数据的数据库中仅存储了2014年12月1日之后的数据，将查询不到在此之前的日期，即使有查到，也是不可信的脏数据； 2、请开发者在调用接口获取数据后，将数据保存在自身数据库中，即加快下次用户的访问速度，也降低了微信侧接口调用的不必要损耗。 3、额外注意，获取图文群发每日数据接口的结果中，只有中间页阅读人数+原文页阅读人数+分享转发人数+分享转发次数+收藏次数 >=3的结果才会得到统计，过小的阅读量的图文消息无法统计。
圖文分析資料介面指的是用於取得公眾平台官網資料統計模組中圖文分析資料的接口，具體介面清單如下：
| 介面名稱 | 最大時間跨度 | 介面呼叫位址（必須使用https） |
|---|---|---|
| 取得圖文群發每日資料（getarticlesummary） | 1 | https://api.weixin.qq.com/datacube/getarticlesummary?access_token=ACCESS_TOKEN |
| #取得圖文群發總資料（getarticletotal） | 1 | https://api.weixin.qq.com/datacube/getarticletotal?access_token=ACCESS_TOKEN |
| 取得圖文統計（getuserread） | 3 | https://api.weixin.qq.com/datacube/getuserread?access_token=ACCESS_TOKEN |
| #取得圖文統計分時資料（getuserreadhour） | 1 | https://api.weixin.qq.com/datacube/getuserreadhour?access_token=ACCESS_TOKEN |
| 取得圖文分享轉送資料（getusershare） | 7 | https://api.weixin.qq.com/datacube/getusershare? access_token=ACCESS_TOKEN |
| 取得圖文分享轉送分時資料（getusersharehour） | 1 | https://api.weixin.qq.com/datacube/getusersharehour?access_token=ACCESS_TOKEN |
最大時間跨度是指一次介面呼叫時最大可取得資料的時間範圍，如最大時間跨度為7是指最多一次性取得7天的資料。 access_token的實際值請透過「取得access_token」來取得。
介面呼叫請求說明
圖文分析資料介面（包含介面清單中的所有介面）需要呼叫對應介面位址POST以下範例封包：
{
"begin_date": "2014-12-08",
"end_date": "2014-12-08"
}呼叫參數說明
#| 參數 | 是否必須 | 說明 |
|---|---|---|
| access_token | 是 | 呼叫介面憑證 |
| begin_date | 是 | 取得資料的起始日期，begin_date和end_date的差值需小於「最大時間跨度」（例如最大時間跨度為1時，begin_date和end_date的差值只能為0，才能小於1），否則會報錯 |
| end_date | 是 | 取得資料的結束日期，end_date允許設定的最大值為昨日 |
回傳說明
正常情況下，取得圖文群發每日資料介面的回傳JSON封包如下：
{
"list": [
{
"ref_date": "2014-12-08",
"msgid": "10000050_1",
"title": "12月27日 DiLi日报",
"int_page_read_user": 23676,
"int_page_read_count": 25615,
"ori_page_read_user": 29,
"ori_page_read_count": 34,
"share_user": 122,
"share_count": 994,
"add_to_fav_user": 1,
"add_to_fav_count": 3
}
//后续会列出该日期内所有被阅读过的文章（仅包括群发的文章）在当天的阅读次数等数据
]
}正常情況下，取得圖文群發總資料介面的回傳JSON封包如下（請注意，details中，每天對應的數值為該文章到該日為止的總量（而不是當日的量））。 額外需要注意取得圖文群發每日資料（getarticlesummary）和取得圖文群發總資料（getarticletotal）的差異如下：
1、前者获取的是某天所有被阅读过的文章（仅包括群发的文章）在当天的阅读次数等数据。 2、后者获取的是，某天群发的文章，从群发日起到接口调用日（但最多统计发表日后7天数据），每天的到当天的总等数据。例如某篇文章是12月1日发出的，发出后在1日、2日、3日的阅读次数分别为1万，则getarticletotal获取到的数据为，距发出到12月1日24时的总阅读量为1万，距发出到12月2日24时的总阅读量为2万，距发出到12月1日24时的总阅读量为3万。
{
"list": [
{
"ref_date": "2014-12-14",
"msgid": "202457380_1",
"title": "马航丢画记",
"details": [
{
"stat_date": "2014-12-14",
"target_user": 261917,
"int_page_read_user": 23676,
"int_page_read_count": 25615,
"ori_page_read_user": 29,
"ori_page_read_count": 34,
"share_user": 122,
"share_count": 994,
"add_to_fav_user": 1,
"add_to_fav_count": 3,
"int_page_from_session_read_user": 657283,
"int_page_from_session_read_count": 753486,
"int_page_from_hist_msg_read_user": 1669,
"int_page_from_hist_msg_read_count": 1920,
"int_page_from_feed_read_user": 367308,
"int_page_from_feed_read_count": 433422,
"int_page_from_friends_read_user": 15428,
"int_page_from_friends_read_count": 19645,
"int_page_from_other_read_user": 477,
"int_page_from_other_read_count": 703,
"feed_share_from_session_user": 63925,
"feed_share_from_session_cnt": 66489,
"feed_share_from_feed_user": 18249,
"feed_share_from_feed_cnt": 19319,
"feed_share_from_other_user": 731,
"feed_share_from_other_cnt": 775
},
//后续还会列出所有stat_date符合“ref_date（群发的日期）到接口调用日期”（但最多只统计7天）的数据
]
},
//后续还有ref_date（群发的日期）在begin_date和end_date之间的群发文章的数据
]
}正常情況下，取得圖文統計資料接口的回傳JSON封包如下：
{
"list": [
{
"ref_date": "2014-12-07",
"int_page_read_user": 45524,
"int_page_read_count": 48796,
"ori_page_read_user": 11,
"ori_page_read_count": 35,
"share_user": 11,
"share_count": 276,
"add_to_fav_user": 5,
"add_to_fav_count": 15
},
//后续还有ref_date在begin_date和end_date之间的数据
]
}正常情況下，取得圖文統計分時資料介面的回傳JSON封包如下：
{
{
"list": [
{
"ref_date": "2015-07-14",
"ref_hour": 0,
"user_source": 0,
"int_page_read_user": 6391,
"int_page_read_count": 7836,
"ori_page_read_user": 375,
"ori_page_read_count": 440,
"share_user": 2,
"share_count": 2,
"add_to_fav_user": 0,
"add_to_fav_count": 0
},
{
"ref_date": "2015-07-14",
"ref_hour": 0,
"user_source": 1,
"int_page_read_user": 1,
"int_page_read_count": 1,
"ori_page_read_user": 0,
"ori_page_read_count": 0,
"share_user": 0,
"share_count": 0,
"add_to_fav_user": 0,
"add_to_fav_count": 0
},
{
"ref_date": "2015-07-14",
"ref_hour": 0,
"user_source": 2,
"int_page_read_user": 3,
"int_page_read_count": 3,
"ori_page_read_user": 0,
"ori_page_read_count": 0,
"share_user": 0,
"share_count": 0,
"add_to_fav_user": 0,
"add_to_fav_count": 0
},
{
"ref_date": "2015-07-14",
"ref_hour": 0,
"user_source": 4,
"int_page_read_user": 42,
"int_page_read_count": 100,
"ori_page_read_user": 0,
"ori_page_read_count": 0,
"share_user": 0,
"share_count": 0,
"add_to_fav_user": 0,
"add_to_fav_count": 0
}
//后续还有ref_hour逐渐增大,以列举1天24小时的数据
]
}正常情況下，取得圖文分享轉送數據介面的回傳JSON封包如下：
{
"list": [
{
"ref_date": "2014-12-07",
"share_scene": 1,
"share_count": 207,
"share_user": 11
},
{
"ref_date": "2014-12-07",
"share_scene": 5,
"share_count": 23,
"share_user": 11
}
//后续还有不同share_scene（分享场景）的数据，以及ref_date在begin_date和end_date之间的数据
]
}正常情況下，取得圖文分享轉送每日資料介面的回傳JSON封包如下：
{
"list": [
{
"ref_date": "2014-12-07",
"ref_hour": 1200,
"share_scene": 1,
"share_count": 72,
"share_user": 4
}
//后续还有不同share_scene的数据，以及ref_hour逐渐增大的数据。由于最大时间跨度为1，所以ref_date此处固定
]
}傳回參數說明
| 參數 | 說明 |
|---|---|
| #ref_date | 資料的日期，需在begin_date和end_date之間 |
| ref_hour | 資料的小時，包括從000到2300，分別代表的是[000,100)到[2300,2400)，也就是每日的第1小時和最後1小時 |
| stat_date | 統計的日期，在getarticletotal介面中，ref_date指的是文章群發出日期，而stat_date是資料統計日期 |
| msgid | 請注意：這裡的msgid其實是由msgid（圖文訊息id，也就是群發介面呼叫後傳回的msg_data_id）和index（訊息順序索引）組成， 例如12003_3， 其中12003是msgid，即一次群發的訊息的id；3為index，假設該次群發的圖文訊息共5個文章（因為可能為多圖文），3表示5個中的第3個 |
| title | 圖文訊息的標題 |
| int_page_read_user | 圖文頁（點選群發圖文卡片進入的頁面）的閱讀人數 |
| int_page_read_count | 圖文頁的閱讀次數 |
| ori_page_read_user | 原文頁（點選圖文頁「閱讀原文」進入的頁面）的閱讀人數，無原文頁時此處資料為0 |
| ori_page_read_count | 原文頁的閱讀次數 |
| #share_scene | 分享的場景 1代表好友轉寄2代表朋友圈3代表騰訊微博255代表其他 |
| share_user | 分享的人數 |
| share_count | 分享的次數 |
| add_to_fav_user | #收藏的人數 |
| add_to_fav_count | #收藏的次數 |
| 取得圖文群發總資料介面中的詳細欄位解釋 | intpagefromsessionreaduser 公眾號會話閱讀人數 |
| target_user | 送達人數，一般約等於總粉絲數（需排除黑名單或其他異常情況下無法收到訊息的粉絲） |
| user_source | 在取得圖文閱讀分時資料時才有該字段，代表使用者從哪裡進入來閱讀該圖文。 0:會話;1.好友;2.朋友圈;3.騰訊微博;4.歷史訊息頁;5.其他 |
錯誤時微信會回傳錯誤碼等信息，具體錯誤碼查詢，請見：全域回傳碼說明
