# Get Service Provider Ad Summary Data

Interface should be called on the server side, seeHattori API。

# Interface Dxplaination

# Interface name

GetAgencyAdsStat

# Functional description

this API Used to obtain aggregate advertising data generated by the service provider through the traffic master generation operation model. If you encounter problems during use, you canOpen Platform Service Provider Zone Exchange Zone | WeChat Open CommunityPosting exchanges.

# Note

Where access_Token forcomponent_access_Token

# Calling mode

# HTTPS call


初始值 https://api.weixin.qq.com/wxa/getdefaultamsinfo?action=get_agency_ads_stat&access_token=xxxxxxxxxxxxxxx

# Request parameters

attribute	type	Required	Introductions
page	number	yes	Number of data returned
page_size	number	yes	Number of returned data bars per page
start_date	string	yes	Start time to get data yyyy-mm-dd
end_date	string	yes	End time of getting data yyyy-mm-dd
ad_slot	string	no	Ad Space Type Name

# Return parameters

attribute

type

Introductions

ret

number

Error code

err_msg

string

Return error message

summary

array

summary

attribute	type	Introductions
click_count	number	Total hits
exposure_count	string	Total exposure
income	number	Total advertising revenue(Cent)
req_Stn_count	number	Total drawback
ecpm	number	Summary eCPM(Cent)
exposure_rate	number	Summary exposure
click_rate	number	Aggregate click rate
publisher_income	number	Total Mini Program Split Income(Cent)
agency_income	number	Total service provider income after splitting(Cent)
exposure_uv	number	Total exposure uv
open_uv	number	Always open uv

list

array

list

attribute	type	Introductions
date	string	date
click_count	number	number of clicks
exposure_count	number	Number of exposures
income	number	Total advertising revenue per day(Cent)
req_Stn_count	number	Drawback
ecpm	number	eCPM(Cent)
exposure_rate	number	Exposure
click_rate	number	click-through rate
ad_slot	string	Ad Space Type Name
publisher_income	number	Income after division of Mini programs(Cent)
agency_income	number	Revenue after service provider's split(Cent)
publisher_appid	string	Appid Mini Program

total_num

number

Request to return the total number of articles

# Call Example

Example Dxplaination: HTTPS requests

# Sample Request Data


{
    "page": 1,
    "page_size": 8,
    "start_date": "2020-04-13",
    "end_date":"2020-04-13",
    "ad_slot": "SLOT_ID_WEAPP_INTERSTITIAL"
}

# Return Data Example


{
    "right": 0,
    "err_msg":"", // Failure to return only
    "list":[
        {
            "slot_id":3030046789020061,
            "ad_slot":"SLOT_ID_WEAPP_INTERSTITIAL",
            "date":"2021-04-13",
            "req_Stn_count":443610,
            "exposure_count":181814,
            "exposure_rate":0.409850995,
            "click_count":10095,
            "click_rate":0.055523777,
            "income":104350,
            "ecpm":286.969100289,
            "agency_income":52175,
            "publisher_income":52175,
	    "publisher_appid":"wxf3dsfsdf13d"
        }
    ],
    "summary":{
        "req_Stn_count":4406394,
        "exposure_count":1797225,
        "exposure_rate":0.407867522,
        "click_count":100167,
        "click_rate":0.055734257,
        "income":578003,
        "ecpm":321.608591022
        "exposure_uv":3456,
        "open_uv":4567
    },
    "total_number: 1
}

# Error code

Error code	Error code	Solutions
0	ok	ok
-202	Internal error	Can be retried after some time
1700	Parameter error	Verify that the input parameters conform to the documentation
1701	Parameter error	Verify that the input parameters conform to the documentation
1737	Operating too fast	Wait a minute and reoperate
2056	The service provider does not open an account in the cash area	Launch services in the monetization area of the third-party platform page