菜单

展示和新增用户(1-60天数据)

注意:接入Api前请先熟悉api签名机制(参考接口鉴权说明), 即Api请求样例中的一些http请求头的来源

使用注意:

1.报表延迟一天,建议当天晚上10点左右再拉一次昨天数据(数据可能会持续更新),正常情况此时数据是完整的


说明:

对应后台留存价值报表的展示模块,同时支持查询新增用户数


1 请求URL

https://openapi.toponad.com/v3/impnewuserreport

2 请求方式

POST

3 请求参数

字段类型是否必传备注样例
start_dateIntY开始日期,格式:YYYYmmdd,支持时间必须大于2018010120190501
end_dateIntY结束日期,格式:YYYYmmdd,支持时间必须大于2018010120190506
app_id_listArray[String]Y开发者后台的应用ID列表,暂时必须且只能传一个[“a600e6fbeac98c”],
placement_id_listArray[String]N开发者后台的广告位ID列表,不传默认开发者的全部广告位[“b600e6fbeac98c”],
geo_short_listArray[String]N国家短码列表,不传默认所有国家[“US”,"CN"]
channel_listArray[String]N渠道列表,不传默认所有渠道[“haoyou”]
time_zoneStringY时区,枚举值:UTC-8、UTC+8、UTC+0“UTC-8”
startIntN偏移数,代表从第几条数据开始,默认为00
limitIntN每次拉取数据的最大条数,默认是1000,可选[1,1000]不传默认1000,最大1000
group_byArray[String]Ngroup by 维度,不传时默认date_time,支持的维度说明
date_time(日期,默认值),
app_id(应用),
placement_id(广告位),
geo_short(地区短码),
channel(渠道),
["date_time"]

4 返回参数

字段类型是否必传备注
recordsArray[Object]N记录,对象数组每个record结构见下面records元素结构,无数据时为空
countIntN总条数,无数据时为空

records元素结构如下:

字段名类型是否必传备注
date_timeIntN日期,格式:YYYYmmdd。group_by有选date_time才有返回
app_idStringN开发者后台的应用ID,group_by有选app_id维度时才返回
app_nameStringN应用名称,group_by有选app_id维度时才返回
placement_idStringN开发者后台的广告位ID,group_by有选placement_id维度时才返回
placement_nameStringN广告位名称,group_by有选placement_id维度时才返回
geo_shortStringN国家码,group_by有选geo_short维度时才有返回
channelStringN渠道,group_by有选channel才有返回
new_userIntY新增用户数
impression_1StringY第1天用户价值广告位的展示/新增用户
注意:开发者后台的是当天总展示数并且每天累加前一天,api返回的是新用户平均展示数,例如:
impression_1*new_user=后台的imp0,
impression_2*new_user=后台的(imp1-imp0),
...StringY第2到第59天用户价值广告位的展示/新增用户
impression_60StringY第60天用户价值广告位的展示/新增用户

5 样例

请求样例:

curl --location --request POST 'https://openapi.toponad.com/v3/impnewuserreport' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_date":20211203,
    "end_date":20211216,
    "timezone_api":"UTC-8",
    "offset":0,
    "app_id_list": ["a5df88b5140222"],
    "placement_id_list": ["b5df88bc03222c"],
    "limit":1,
    "group_by": ["date_time"]
}'

返回样例:

{
    "count": 14,
    "records": [
        {
            "date_time": 20211203,
            "new_user": 12000,
            "impression_1": "2.612",
            "impression_2": "1.5897",
            "impression_3": "0.7926",
            "impression_4": "0.3768",
            "impression_5": "0.276",
            "impression_6": "0.227",
            "impression_7": "0.1569",
            "impression_8": "0.159",
            "impression_9": "0.1974",
            "impression_10": "0.1485",
            "impression_11": "0.086",
            "impression_12": "0.073",
            "impression_13": "0.0813",
            "impression_14": "0.0541",
            "impression_15": "0.0749",
            "impression_16": "0",
            "impression_17": "0",
            "impression_18": "0",
            "impression_19": "0",
            "impression_20": "0",
            "impression_21": "0",
            "impression_22": "0",
            "impression_23": "0",
            "impression_24": "0",
            "impression_25": "0",
            "impression_26": "0",
            "impression_27": "0",
            "impression_28": "0",
            "impression_29": "0",
            "impression_30": "0",
            "impression_31": "0",
            "impression_32": "0",
            "impression_33": "0",
            "impression_34": "0",
            "impression_35": "0",
            "impression_36": "0",
            "impression_37": "0",
            "impression_38": "0",
            "impression_39": "0",
            "impression_40": "0",
            "impression_41": "0",
            "impression_42": "0",
            "impression_43": "0",
            "impression_44": "0",
            "impression_45": "0",
            "impression_46": "0",
            "impression_47": "0",
            "impression_48": "0",
            "impression_49": "0",
            "impression_50": "0",
            "impression_51": "0",
            "impression_52": "0",
            "impression_53": "0",
            "impression_54": "0",
            "impression_55": "0",
            "impression_56": "0",
            "impression_57": "0",
            "impression_58": "0",
            "impression_59": "0",
            "impression_60": "0"
        }
    ]
}


上一个
留存(2-60天数据)
下一个
Roi报表
最近修改: 2025-05-30Powered by