Data statistics interface-message analysis data interface

WeChat public platform launched an invitation-based internal test of the data interface on January 6, 2015. Through the data interface, developers can obtain data similar to the statistical module of the official WeChat public platform website but more flexible, and can also perform advanced processing as needed.

During the invitation beta test, in order to ensure service quality, the data interface is only open to third-party platform developers. You can become a third-party platform developer by accessing the WeChat Open Platform and authorizing the public account login. The third-party platform can help operators manage public accounts and help authorized public accounts call data interfaces. In the permission set division of the public account login authorization mechanism, the message analysis data interface belongs to the message and menu permission set.

The time for opening the data interface to all public account developers will be notified separately.

Please note:

1. The database of the public account data on the interface side only stores data after December 1, 2014. Data before that date cannot be queried. Even if data is found, it is unreliable and dirty data.
2. After calling the interface to obtain data, developers should save the data in their own database, which will speed up the next user's access and reduce unnecessary losses in calling the interface on the WeChat side.

The message analysis data interface refers to the interface used to obtain the message analysis data in the data statistics module of the official website of the public platform. The specific interface list is as follows (there is no message keyword data interface):

***Time span refers to the time range in which data can be obtained when an API is called. For example, ***Time span of 7 means that a maximum of 7 days of data can be obtained at one time. The actual value of access_token can be obtained through "Get access_token".

Regarding weekly and monthly data, please note that the data of each monthly/weekly periodic data is marked on the last day of the month/week (the 1st of the month or Monday). You can only get the data of that period by calling the interface after a month/week. For example, on December 1, calling the monthly data acquisition interface with (November 1st-November 5th) as (begin_date and end_date) can get the monthly data of November 1st (i.e. the monthly data of November).

Interface call request description

The message analysis data interface (including all interfaces in the interface list) needs to POST the following sample data packet to the corresponding interface call address:

{ 
    "begin_date": "2014-12-07", 
    "end_date": "2014-12-08"
}

Call parameter description

Return Description

To obtain the message sending profile data interface, you need to POST the following data packet to the corresponding interface call address:

{
 "list": [
 {
           "ref_date": "2014-12-07",
 "msg_type": 1,
 "msg_user": 282,
 "msg_count": 817
 }
 // There will be data of different msg_type with the same ref_date, and data of different ref_date (within the time range) later.
 ]
 }

To obtain the message distribution time-sharing data interface, you need to POST the following data packet to the corresponding interface call address:

 {
 "list": [
 {
           "ref_date": "2014-12-07",
 "ref_hour": 0,
 "msg_type": 1,
 "msg_user": 9,
 "msg_count": 10
 }
 //There will be data of different msg_types in the same ref_hour and data of different ref_hours in the future. ref_date is fixed because the maximum time span is 1
 ]
 } 
 
 The JSON data packet returned by the interface for obtaining weekly data of message sending is as follows: 
 
 {
 "list": [
 {
           "ref_date": "2014-12-08",
 "msg_type": 1,
 "msg_user": 16,
 "msg_count": 27
 }
 //Subsequently, there will be data with different msg_type and different ref_date under the same ref_date
 ]
 }

The JSON data packet returned by the interface for obtaining monthly data of message sending is as follows:

{
 "list": [
 {
           "ref_date": "2014-11-01",
 "msg_type": 1,
 "msg_user": 7989,
 "msg_count": 42206
 }
 //Subsequently, there will be data with different msg_type and different ref_date under the same ref_date
 ]
 }

The JSON data packet returned by the interface for getting message sending distribution data is as follows:

{
 "list": [
 {
           "ref_date": "2014-12-07",
           "count_interval": 1,
 "msg_user": 246
 }
 //Subsequently, there will be data with different count_intervals under the same ref_date, and data with different ref_dates
 ]
 }

The JSON data packet returned by the interface for obtaining weekly data of message sending distribution is as follows:

{
 "list": [
 {
           "ref_date": "2014-12-07",
           "count_interval": 1,
 "msg_user": 246
 }
 //Subsequently, there will be data with different count_intervals under the same ref_date, and data with different ref_dates
 ]
 }

The JSON data packet returned by the interface for obtaining the monthly data of message sending distribution is as follows:

{
 "list": [
 {
           "ref_date": "2014-12-07",
           "count_interval": 1,
 "msg_user": 246
 }
 //Subsequently, there will be data with different count_intervals under the same ref_date, and data with different ref_dates
 ]
 }

Return parameter description

WeChat will return error codes and other information when an error occurs. For specific error code queries, please see: Global Return Code Description