訊息分析資料介面
訊息分析資料介面
#微信公眾平台於2015年1月6日啟動了資料介面的邀請內測。透過數據接口,開發者可以獲得與公眾平台官網統計模組類似但更靈活的數據,還可根據需要進行高級處理。
在公眾號登入授權機制的權限集分割中,訊息分析資料介面屬於訊息管理權限。
向所有公眾號開發者開放資料介面的時間將另行通知。
請注意:
1、接口侧的公众号数据的数据库中仅存储了2014年12月1日之后的数据,将查询不到在此之前的日期,即使有查到,也是不可信的脏数据; 2、请开发者在调用接口获取数据后,将数据保存在自身数据库中,即加快下次用户的访问速度,也降低了微信侧接口调用的不必要损耗。
訊息分析資料介面指的是用於取得公眾平台官網資料統計模組中訊息分析資料的接口,具體介面清單如下(暫無訊息關鍵字數據接口):
介面名稱 | 最大時間跨度 | 介面呼叫位址(必須使用https) |
---|---|---|
取得訊息傳送概況資料(getupstreammsg) | 7 | https://api.weixin.qq.com/datacube/getupstreammsg?access_token=ACCESS_TOKEN |
#取得訊息分發分時資料(getupstreammsghour) | 1 | https://api.weixin.qq.com/datacube/getupstreammsghour?access_token=ACCESS_TOKEN |
取得訊息發送週資料(getupstreammsgweek) | 30 | https://api.weixin.qq.com/datacube/getupstreammsgweek?access_token=ACCESS_TOKEN |
#取得訊息發送月資料(getupstreammsgmonth) | 30 | https://api.weixin.qq.com/datacube/getupstreammsgmonth?access_token=ACCESS_TOKEN |
#取得訊息發送分佈資料(getupstreammsgdist) | 15 | https://api.weixin.qq.com/datacube/getupstreammsgdist?access_token=ACCESS_TOKEN |
取得訊息發送分佈週資料(getupstreammsgdistweek) | 30 | https://api.weixin.qq.com/datacube/getupstreammsgdistweek?access_token=ACCESS_TOKEN |
取得訊息發送分佈月資料(getupstreammsgdistmonth) | 30 | https://api.weixin.qq.com/datacube/getupstreammsgdistmonth?access_token=ACCESS_TOKEN |
最大時間跨度是指一次介面呼叫時最大可取得資料的時間範圍,如最大時間跨度為7是指最多一次性取得7天的資料。 access_token的實際值請透過「取得access_token」來取得。
關於週數據與月數據,請注意:每個月/週的週期數據的數據標註日期在當月/當週的第一天(當月1日或週一)。在某一月/週過後去呼叫接口,才能取得到該週期的資料。例如,在12月1日以(11月1日-11月5日)作為(begin_date和end_date)調用獲取月數據接口,可以獲取到11月1日的月數據(即11月的月數據)。
介面呼叫請求說明
訊息分析資料介面(包含介面清單中的所有介面)需要向對應介面呼叫位址POST下列範例封包:
{ "begin_date": "2014-12-07", "end_date": "2014-12-08" }
呼叫參數說明
參數 | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 呼叫介面憑證 |
begin_date | 是 | 取得資料的起始日期,begin_date和end_date的差值需小於「最大時間跨度」(例如最大時間跨度為1時,begin_date和end_date的差值只能為0,才能小於1),否則會報錯 |
end_date | 是 | 取得資料的結束日期,end_date允許設定的最大值為昨日 |
回傳說明
取得訊息傳送概況資料介面需要向對應介面呼叫位址POST以下封包:
{ "list": [ { "ref_date": "2014-12-07", "msg_type": 1, "msg_user": 282, "msg_count": 817 } //后续还有同一ref_date的不同msg_type的数据,以及不同ref_date(在时间范围内)的数据 ] }
取得訊息分送分時資料介面需要向對應介面呼叫位址POST以下封包:
{ "list": [ { "ref_date": "2014-12-07", "ref_hour": 0, "msg_type": 1, "msg_user": 9, "msg_count": 10 } //后续还有同一ref_hour的不同msg_type的数据,以及不同ref_hour的数据,ref_date固定,因为最大时间跨度为1 ] }
取得訊息傳送週資料介面的回傳JSON封包如下:
{ "list": [ { "ref_date": "2014-12-08", "msg_type": 1, "msg_user": 16, "msg_count": 27 } //后续还有同一ref_date下不同msg_type的数据,及不同ref_date的数据 ] }
取得訊息傳送月資料介面的回傳JSON封包如下:
{ "list": [ { "ref_date": "2014-11-01", "msg_type": 1, "msg_user": 7989, "msg_count": 42206 } //后续还有同一ref_date下不同msg_type的数据,及不同ref_date的数据 ] }
取得訊息傳送分佈資料介面的回傳JSON封包如下:
{ "list": [ { "ref_date": "2014-12-07", "count_interval": 1, "msg_user": 246 } //后续还有同一ref_date下不同count_interval的数据,及不同ref_date的数据 ] }
取得訊息傳送分佈週資料介面的回傳JSON封包如下:
{ "list": [ { "ref_date": "2014-12-07", "count_interval": 1, "msg_user": 246 } //后续还有同一ref_date下不同count_interval的数据,及不同ref_date的数据 ] }
取得訊息傳送分佈月資料介面的回傳JSON封包如下:
{ "list": [ { "ref_date": "2014-12-07", "count_interval": 1, "msg_user": 246 } //后续还有同一ref_date下不同count_interval的数据,及不同ref_date的数据 ] }
傳回參數說明
參數 | 說明 |
---|---|
#ref_date | 資料的日期,需在begin_date和end_date之間 |
ref_hour | 資料的小時,包括從000到2300,分別代表的是[000,100)到[2300,2400),也就是每日的第1小時和最後1小時 |
msg_type | 訊息類型,代表意義如下: 1代表文字2代表圖片3代表語音4代表視訊6代表第三方應用訊息(連結訊息) |
msg_user | 上行發送了(向公眾號發送了)訊息的使用者數量 |
msg_count | 上行發送了訊息的訊息總數 |
count_interval | 當日發送訊息量分佈的區間,0代表“0”, 1代表“1-5”,2代表“6-10”,3代表“10次以上” |
int_page_read_count | 圖文頁的讀取次數 |
ori_page_read_user | 原文頁(點選圖文頁「閱讀原文」進入的頁面)的閱讀人數,無原文頁時此處資料為0 |
錯誤時微信會傳回錯誤碼等訊息,具體錯誤碼查詢,請見:全域回傳碼說明