菜单

Roi报表

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

1 请求URL

https://openapi.toponad.com/v3/report/roi

2 请求方式

POST

3 请求参数

字段	类型	是否必传	备注	样例
roi_platform	Int	Y	roi归因平台，枚举说明： 1: Adjust方式 2: 热云/自归因	1
start_date	Int	Y	开始日期，格式：YYYYmmdd	20190501
end_date	Int	Y	结束日期，格式：YYYYmmdd	20190506
time_zone	String	Y	时区，枚举值：UTC-8、UTC+8、UTC+0	“UTC-8”
nw_firm_id_list	Array[Int]	N	投放平台ID列表：有效值说明： 100000：巨量引擎 100001：腾讯广告 100002：Mintegral
app_id_list	Array[String]	N	开发者后台的应用ID列表	[“a600e6fbeac98c”]，
campaign_id_list	Array[String]	N	广告组ID列表
ad_group_id_list	Array[String]	N	广告计划ID列表
creative_id_list	Array[String]	N	广告创意ID列表
geo_short_list	Array[String]	N	国家短码列表，不传默认所有国家	[“US”,"CN"]
start	Int	N	偏移数，代表从第几条数据开始，默认为0	0
limit	Int	N	每次拉取数据的最大条数，默认是1000，可选[1,1000]	不传默认1000，最大1000
group_by	Array[String]	N	group by 维度，不传时默认date_time，支持的维度说明 date_time（日期）， app_id（应用）， nw_firm_id（投放平台ID）， geo_short（地区短码）， campaign_id（广告组ID）， adgroup_id（广告计划ID）， creative_id（广告创意ID）	["date_time"]

4 返回参数

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

records元素结构如下：

字段名	类型	是否必传	备注
date_time	Int	N	日期，格式：YYYYmmdd。group_by有选date_time才有返回
app_id	String	N	开发者后台的应用ID，group_by有选app_id维度时才返回
nw_firm_id	Int	N	投放平台ID，group_by有选nw_firm_id维度时才返回
campaign_id	String	N	广告组ID，group_by有选campaign_id维度时才返回
adgroup_id	String	N	广告计划ID，group_by有选adgroup_id维度时才返回
creative_id	String	N	广告创意ID，group_by有选creative_id维度时才返回
geo_short	String	N	国家码，group_by有选geo_short维度时才有返回
new_user	Int	Y	新增用户数
new_user_gap	String	Y	新增用户Gap
cost	Float	Y	投放成本
install	Int	Y	安装量
install_price	String	Y	安装单价
roi_1	String	Y	第1天ROI
...	String	Y	第2到第59天ROI
roi_60	String	Y	第60天ROI

5 样例

请求样例：

curl --location --request POST 'https://openapi.toponad.com/v3/report/roi' \
--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": 20211026,
  "end_date": 20211026,
  "roi_platform": 1,
  "nw_firm_id_list": [100002],
  "time_zone": "UTC+8",    
  "group_by": ["date_time"],
  "limit": 100,
  "start": 0
}'

返回样例：

{
    "count": 1,
    "records": [
        {
            "date_time": 20211026,
            "new_user": 13061,
            "new_user_gap": "-0.4522",
            "cost": 45901.0955949819,
            "install": 23845,
            "install_price": "1.924978",
            "roi_1": "0.2386",
            "roi_2": "0.2968",
            "roi_3": "0.3228",
            "roi_4": "0.3409",
            "roi_5": "0.355",
            "roi_6": "0.3672",
            "roi_7": "0.3753",
            "roi_8": "0.3808",
            "roi_9": "0.3855",
            "roi_10": "0.3889",
            "roi_11": "0.393",
            "roi_12": "0.3974",
            "roi_13": "0.4011",
            "roi_14": "0.4045",
            "roi_15": "0.4077",
            "roi_16": "0.4097",
            "roi_17": "0.4121",
            "roi_18": "0.4141",
            "roi_19": "0.4169",
            "roi_20": "0.4189",
            "roi_21": "0.4211",
            "roi_22": "0.4226",
            "roi_23": "0.4244",
            "roi_24": "0.426",
            "roi_25": "0.4284",
            "roi_26": "0.4302",
            "roi_27": "0.4324",
            "roi_28": "0.4339",
            "roi_29": "0.4355",
            "roi_30": "0.4373",
            "roi_31": "0.4394",
            "roi_32": "0.4409",
            "roi_33": "0.4421",
            "roi_34": "0.4436",
            "roi_35": "0.4446",
            "roi_36": "0.4457",
            "roi_37": "0.4465",
            "roi_38": "0.4474",
            "roi_39": "0.4482",
            "roi_40": "0.4495",
            "roi_41": "0.4506",
            "roi_42": "0.4514",
            "roi_43": "0.452",
            "roi_44": "0.4528",
            "roi_45": "0.4535",
            "roi_46": "0.4542",
            "roi_47": "0.4552",
            "roi_48": "0.4559",
            "roi_49": "0.4564",
            "roi_50": "0.4569",
            "roi_51": "0.4575",
            "roi_52": "0.4578",
            "roi_53": "0.4587",
            "roi_54": "0.4594",
            "roi_55": "0.4599",
            "roi_56": "0.4604",
            "roi_57": "0.461",
            "roi_58": "0.4615",
            "roi_59": "0.4619",
            "roi_60": "0.4623"
        }
    ]
}

上一个

展示和新增用户（1-60天数据）

下一个

Roi_Ltv报表

最近修改: 2025-08-15Powered by

大纲