LTV Report

Note: Please be familiar with the API signature mechanism before accessing the API (refer to the API authentication description), that is, the source of some HTTP request headers in the API request sample.

1.Request URL

https://openapi.hyperbid.com/v1/report/ltv

2.Request method

POST

3.Request Parameters

param	type	required	note	sample
time_zone	String	Y	Time zone, enumeration value: UTC-8, UTC+8, UTC+0	“UTC-8”
start_date	Int	Y	Start date, format: YYYYmmdd	20250101
end_date	Int	Y	End date, format: YYYYmmdd	20250101
app_id_list	Array[String]	Y	A list of multiple Mediation Application IDs in the developer backend, at least one appId is required	[“j95ca72d3ece8f62”]
geo_short_list	Array[String]	N	Country short code list, default is all countries	[“US”,"CN"]
start	Int	N	The offset number indicates the starting point of the data. The default value is 0.	0
limit	Int	N	The maximum number of data to be pulled each time, the default is 1000, optional [1,1000]	If not specified, the default value is 1000, and the maximum value is 1000
group_by	Array[String]	N	group by dimension, defaults to date_time if not passed, supported dimension descriptions  date_time (date),  app_id (application),  geo_short (region short code),  channel (channel) Note: When passing in other dimensions, date_time must be included.	["date_time"]

4.Return Parameters

param	type	required	note
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	Total number of entries, empty if no data is availabletime_zone
time_zone	String	N	Time zone, enumeration value: UTC-8, UTC+8, UTC+0
currency	String	N	The currency of the developer account

The records element structure is as follows:

param	type	required	note
date_time	Int	N	Date, format: YYYYmmdd. Only returned if date_time is selected in group_by
app_id	String	N	The application ID of the developer backend. This is returned only when the app_id dimension is selected in group_by.
geo_short	String	N	Country code. Returned only when geo_short dimension is selected in group_by
channel	String	N	Country code. Returned only when group_by has the channel dimension selected and is not empty.
new_user	Int	Y	Number of new users
ltv_1	String	Y	Day 1 LTV
...	String	Y	LTV from Day 2 to Day 89
ltv_90	String	Y	Day 90 LTV

5.Examples

Request Sample:

curl --location --request POST 'https://openapi.hyperbid.com/v1/report/ltv' \
--header 'X-Up-Key: a5c20012d6964913dcea19dbb09243282518505c' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1735716753000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_date": 20250101,
    "end_date": 20250101,
    "group_by":["date_time"],
    "start": 0,
    "limit": 30,
    "time_zone": "UTC+8",
    "app_id_list":["jafc84034d4a8922"]
}'

Response example:

{
    "count": 1,
    "time_zone": "UTC+8",
    "currency": "USD"
    "records": [
        {
            "date_time": 20250101,
            "new_user": 70,
            "ltv_1": "",
            "ltv_2": "",
            "ltv_3": "",
            "ltv_4": "",
            "ltv_5": "",
            "ltv_6": "",
            "ltv_7": "",
            "ltv_8": "",
            "ltv_9": "",
            "ltv_10": "",
            "ltv_11": "",
            "ltv_12": "",
            "ltv_13": "",
            "ltv_14": "",
            "ltv_15": "",
            "ltv_16": "",
            "ltv_17": "",
            "ltv_18": "",
            "ltv_19": "",
            "ltv_20": "",
            "ltv_21": "",
            "ltv_22": "",
            "ltv_23": "",
            "ltv_24": "",
            "ltv_25": "",
            "ltv_26": "",
            "ltv_27": "",
            "ltv_28": "",
            "ltv_29": "",
            "ltv_30": "",
            "ltv_31": "",
            "ltv_32": "",
            "ltv_33": "",
            "ltv_34": "",
            "ltv_35": "",
            "ltv_36": "",
            "ltv_37": "",
            "ltv_38": "",
            "ltv_39": "",
            "ltv_40": "",
            "ltv_41": "",
            "ltv_42": "",
            "ltv_43": "",
            "ltv_44": "",
            "ltv_45": "",
            "ltv_46": "",
            "ltv_47": "",
            "ltv_48": "",
            "ltv_49": "",
            "ltv_50": "",
            "ltv_51": "",
            "ltv_52": "",
            "ltv_53": "",
            "ltv_54": "",
            "ltv_55": "",
            "ltv_56": "",
            "ltv_57": "",
            "ltv_58": "",
            "ltv_59": "",
            "ltv_60": "",
            "ltv_61": "",
            "ltv_62": "",
            "ltv_63": "",
            "ltv_64": "",
            "ltv_65": "",
            "ltv_66": "",
            "ltv_67": "",
            "ltv_68": "",
            "ltv_69": "",
            "ltv_70": "",
            "ltv_71": "",
            "ltv_72": "",
            "ltv_73": "",
            "ltv_74": "",
            "ltv_75": "",
            "ltv_76": "",
            "ltv_77": "",
            "ltv_78": "",
            "ltv_79": "",
            "ltv_80": "",
            "ltv_81": "",
            "ltv_82": "",
            "ltv_83": "",
            "ltv_84": "",
            "ltv_85": "",
            "ltv_86": "",
            "ltv_87": "",
            "ltv_88": "",
            "ltv_89": "",
            "ltv_90": ""
        }
    ]
}