介面分析資料介面
介面分析資料介面
#微信公眾平台於2015年1月6日啟動了資料介面的邀請內測。透過數據接口,開發者可以獲得與公眾平台官網統計模組類似但更靈活的數據,還可根據需要進行高級處理。
在公眾號碼登入授權機制的權限集分割中,介面分析資料介面屬於帳號服務權限。
向所有公眾號開發者開放資料介面的時間將另行通知。
請注意:
1、接口侧的公众号数据的数据库中仅存储了2014年12月1日之后的数据,将查询不到在此之前的日期,即使有查到,也是不可信的脏数据; 2、请开发者在调用接口获取数据后,将数据保存在自身数据库中,即加快下次用户的访问速度,也降低了微信侧接口调用的不必要损耗。
接口分析數據接口指的是用於獲得公眾平台官網數據統計模組中接口分析數據的接口,具體接口列表如無用戶屬性數據接口):
介面名稱 | 最大時間跨度 | 介面呼叫位址(必須使用https) |
---|---|---|
取得介面分析資料(getinterfacesummary) | 30 | https://api.weixin.qq.com/datacube/getinterfacesummary?access_token=ACCESS_TOKEN |
最大時間跨度是指一次介面呼叫時最大可取得資料的時間範圍,如最大時間跨度為7是指最多一次性取得7天的資料。 access_token的實際值請透過「取得access_token」來取得。
介面呼叫請求說明
介面分析資料介面(包含介面清單中的所有介面)需要在對應介面上呼叫位址POST以下範例封包:
{ "begin_date": "2014-12-07", "end_date": "2014-12-07" }
呼叫參數說明
參數 | 是否必須 | 說明 |
---|---|---|
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-07", "callback_count": 36974, "fail_count": 67, "total_time_cost": 14994291, "max_time_cost": 5044 } //后续还有不同ref_date(在begin_date和end_date之间)的数据 ] }
正常情況下,取得介面分析分時數據介面的回傳JSON封包如下:
{ "list": [ { "ref_date": "2014-12-01", "ref_hour": 0, "callback_count": 331, "fail_count": 18, "total_time_cost": 167870, "max_time_cost": 5042 } //后续还有不同ref_hour的数据 ] }
傳回參數說明
#參數 | 說明 |
---|---|
#ref_date | 資料的日期 |
ref_hour | 資料的小時 |
callback_count | 透過伺服器設定位址取得訊息後,被動回覆使用者訊息的次數 |
fail_count | 上述動作的失敗次數 |
total_time_cost | 總耗時,除以callback_count即為平均耗時 |
max_time_cost | 最大耗時 |
錯誤時微信會傳回錯誤碼等訊息,具體錯誤碼查詢,請見:全域回傳碼說明