# Dxplaination of the ad analysis data interface

Open data interfaces to all Official Account, Weixin Mini Program, MiniGame developers who become traffic masters.Through the data interface, developers can access data similar to, but more flexible, statistical modules on the public platform's official website, and can perform advanced processing as needed.

Please note:

1. The interface-side database only stores data after January 1, 2016, and previous data will not be retrieved, and even if it is found, it will be untrusted and dirty;

2. It is recommended that developers save the data in their own databases after calling the interface to obtain the data, to maximize the efficiency of access and also to reduce unnecessary losses from the WeChat side interface calls.

3. Due to the large amount of data, all interfaces take a page-by-page approach, with a maximum page acquisition of 90.(eg: total_num is 100, then when page = 1, page_size = 10, the first 10 entries are returned;)Page = 1, page_size = 20, then the first 20 entries are returned;Page = 2, page_size = 10, then return articles 11 to 20)

4. Instructions for changing the ad space enumeration value

   • Since multiple interfaces use ad space parameters, to ensure consistency of the experience and readability of the parameters,We made some changes so that all the interfaces support the ad-slot type name (ad_slot) and passing parameters, adding this name to represent the relevant meaning when repackaging.The previous parameter slot_id can also be used and passed back. Specifically:

# Interface Overview

The ad analysis interface is currently available to obtain some of the ad data shown on the Public Platform → Traffic Owners → Statistics page and some of the revenue data shown in the Public Platform > Traffic owners → Financial Management page. The list of interfaces associated with Weixin Mini Program is as follows:

# Dxplaination of Interface Call Request

# I. Get Weixin Mini Program ad summary data (publisher_adpos_general)

You need to add the following GET request parameters to the appropriate interface call address:

Note: If you do not pass atype name, data for alltypes will be returned by default.

Returns parameter explaination (publisher_adpos_general)

Return packet example (publisher_adpos_general)

{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "list":[
        {
            "slot_id":3030046789020061,
            "ad_slot":"SLOT_ID_WEAPP_INTERSTITIAL",
            "date":"2020-04-13",
            "req_succ_count":443610,
            "exposure_count":181814,
            "exposure_rate":0.409850995,
            "click_count":10095,
            "click_rate":0.055523777,
            "income":52175,
            "ecpm":286.969100289
        }
    ],
    "summary":{
        "req_succ_count":4406394,
        "exposure_count":1797225,
        "exposure_rate":0.407867522,
        "click_count":100167,
        "click_rate":0.055734257,
        "income":578003,
        "ecpm":321.608591022
    },
    "total_num":1
}

# II. Get Weixin Mini Program ad segmentation data (publisher_adunit_general)

You need to add the following GET request parameters to the appropriate interface call address:

Please note: When you need to get the breakdown data of all**, you do not need to pass the TAG-type name and TAG-id;When you need to obtain breakdown data for a certain type of ad space, you only need to pass the name of the ad space type; When you need to get the breakdown data of a Guangzhou ID, only the Guangzhou ID is passed.

Returns parameter explaination (publisher_adunit_general)

Returned packet example (publisher_adunit_general)

{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "list":[
        {
            "ad_unit_id":"adunit-9cedd8514XXXX",
            "ad_unit_name":"激励视频长广告",
            "stat_item":{
                "ad_slot":"SLOT_ID_WEAPP_REWARD_VIDEO",
                "date":"2020-04-10",
                "req_succ_count":138250,
                "exposure_count":74771,
                "exposure_rate":0.54083906,
                "click_count":2242,
                "click_rate":0.029984887,
                "income":93883,
                "ecpm":6.790813743
            }
        }
    ],
    "total_num":1
}

# III. Get Weixin Mini Program Advertisement list (get_adunit_list)

You need to add the following GET request parameters to the appropriate interface call address:

Note: When you need to get a list of all**, you do not need to pass the TAG-type name and TAG-ID;When you need to get a list of a certain type of ad space, just pass the name of the ad space type; When you need to get the data for a ID, just pass the ID.

Returns parameter explaination (get_adunit_list)

Returns the example of a digital packet (get_adunit_list)

{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "ad_unit":[
        {
            "ad_slot":"SLOT_ID_WEAPP_REWARD_VIDEO",
            "ad_unit_id":"adunit-e9418ee19XXXXX",
            "ad_unit_name":"rewaXXXX",
            "ad_unit_size":[
                {
                    "height":166,
                    "width":582
                }
            ],
            "ad_unit_status":"AD_UNIT_STATUS_ON",
            "ad_unit_type":"AD_UNIT_TYPE_REWARED_VIDEO",
            "appid":"wx0afc78670fXXXX",
            "video_duration_max":30,
            "video_duration_min":6
        }
    ],
    "total_num":1
}

# IV. Obtain Weixin Mini Program settlement income data and settlement entity information (publisher_settlement)

You need to add the following GET request parameters to the appropriate interface call address:

Please note: As long as it coincides with the start and end of the data obtained, the data corresponding to the settlement interval will be returned.For example, a request for data from 11 February to 26 March would return data from the four clearing areas for the first half of February, the second half of January, and the first half and second half of March.

Returns parameter explaination (publisher_settlement)

Return packet example (publisher_settlement)

{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "body":"深圳市腾讯计算机系统有限公司",
    "penalty_all":0,
    "revenue_all":5178368698,
    "settled_revenue_all":2613696765,
    "settlement_list":[
        {
            "date":"2020-03-25",
            "zone":"2020年3月1日至15日"
            "month":"202003",
            "order":1,
            "sett_status":1,
            "settled_revenue":718926045,
            "sett_no":"XXX",
            "mail_send_cnt":"0",
            "slot_revenue":[
                {
                    "slot_id":"SLOT_ID_WEAPP_BANNER",
                    "slot_settled_revenue":34139443
                },
                {
                    "slot_id":"SLOT_ID_WEAPP_REWARD_VIDEO",
                    "slot_settled_revenue":684786602
                }
            ]
        }
    ],
    "total_num":1
}

# Error code explaination