Roi Ltv Report

1. Request URL

https://api.toponad.net/v3/report/roi_ltv

2. Request method

POST

3. Request params

params	type	required	notes	sample
roi_platform	Int	Y	Roi attribution platform, enumeration value: 1: Adjust 2: TrackingIO/Self-Attribution	1
start_date	Int	Y	Start date, format: YYYYmmdd	20190501
end_date	Int	Y	End date, format: YYYYmmdd	20190506
time_zone	String	Y	UTC+8, UTC+0, UTC-8, default UTC+8	UTC+0
nw_firm_id_list	Array[Int]	N	Network Channel ID list, enumeration value: 100000：Oceanengine 100001：Tencent Ads 100002：Mintegral	[100000]
app_id_list	Array[String]	N	App ID list. For now, only one can be transmitted.	["a600e6fbeac98c"]
campaign_id_list	Array[String]	N	Campaign ID list
ad_group_id_list	Array[String]	N	AdSet ID list
creative_id_list	Array[String]	N	Ad ID list
geo_short_list	Array[String]	N	Country Short Code list	["US"]
start	Int	N	Offset, default 0	0
limit	Int	N	Limit row number. default 1000. [1,1000]	default 1000
group_by	Array[String]	N	Group by dimension. If not specified, the default value is 'date_time'. Supported dimensions are described below. date_time (Date, default value), app_id (Application), nw_firm_id (Network Channel), geo_short (Country Short Code), campaign_id (Campaign), adgroup_id (AdSet), creative_id (Ad)	["date_time","app_id"]

4. Return data

fields	type	required	notes
records	Array[Object]	N	Record, object array. The structure of each record is shown in the records element structure below. It is empty when there is no data.
count	Int	N	Count of the row numbers

records:

fields	type	required	notes
date_time	Int	N	Date. Format: YYYYmmdd. Return if in param 'group_by'
app_id	String	N	App ID. Return if in param 'group_by'
nw_firm_id	Int	N	Network Channel ID. Return if in param 'group_by'
campaign_id	String	N	Campaign ID. Return if in param 'group_by'
adgroup_id	String	N	AdSet ID. Return if in param 'group_by'
creative_id	String	N	Ad ID. Return if in param 'group_by'
geo_short	String	N	Country Short Code. Return if in param 'group_by'
new_user	Int	Y	New User Count
new_user_gap	String	Y	New User Gap
cost	Float	Y	UA Cost
install	Int	Y	Install
install_price	String	Y	Install Price
ltv_xx	String	Y	ltv_(num) (1-60)

5. Sample

Request sample:

curl --location --request POST 'https://api.toponad.net/v3/report/roi_ltv' \
--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
}'

Return data sample:

{
    "count": 1,
    "records": [
        {
            "date_time": 20220317,
            "new_user": 1227,
            "new_user_gap": "",
            "cost": 0,
            "install": 0,
            "install_price": "",
            "ltv_1": "0.1842",
            "ltv_2": "0.2093",
            "ltv_3": "0.234",
            "ltv_4": "0.2403",
            "ltv_5": "0.2438",
            "ltv_6": "0.2459",
            "ltv_7": "0.2512",
            "ltv_8": "0.2552",
            "ltv_9": "0.2577",
            "ltv_10": "0.259",
            "ltv_11": "0.2604",
            "ltv_12": "0.2612",
            "ltv_13": "0.2618",
            "ltv_14": "0",
            "ltv_15": "0",
            "ltv_16": "0",
            "ltv_17": "0",
            "ltv_18": "0",
            "ltv_19": "0",
            "ltv_20": "0",
            "ltv_21": "0",
            "ltv_22": "0",
            "ltv_23": "0",
            "ltv_24": "0",
            "ltv_25": "0",
            "ltv_26": "0",
            "ltv_27": "0",
            "ltv_28": "0",
            "ltv_29": "0",
            "ltv_30": "0",
            "ltv_31": "0",
            "ltv_32": "0",
            "ltv_33": "0",
            "ltv_34": "0",
            "ltv_35": "0",
            "ltv_36": "0",
            "ltv_37": "0",
            "ltv_38": "0",
            "ltv_39": "0",
            "ltv_40": "0",
            "ltv_41": "0",
            "ltv_42": "0",
            "ltv_43": "0",
            "ltv_44": "0",
            "ltv_45": "0",
            "ltv_46": "0",
            "ltv_47": "0",
            "ltv_48": "0",
            "ltv_49": "0",
            "ltv_50": "0",
            "ltv_51": "0",
            "ltv_52": "0",
            "ltv_53": "0",
            "ltv_54": "0",
            "ltv_55": "0",
            "ltv_56": "0",
            "ltv_57": "0",
            "ltv_58": "0",
            "ltv_59": "0",
            "ltv_60": "0"
        }
    ]
}

Roi Report

Hourly Report

Last modified: 2025-08-20Powered by

Outline