Skip to content

Activity List ​

INFO

Lists the activities created by the merchant, with usage totals for each activity.

Request Method ​

ItemNameSample
PathPath{Api_Address}/merchant/activity/list
Request MethodPOST

Request Parameters ​

NameTypeRequiredDescription
Sign ParamsYView details
activity_idstringNFilter by activity ID
activity_namestringNFilter by activity name
create_beginintNCreated at or after this time, Unix seconds
create_endintNCreated at or before this time, Unix seconds
offsetintNPaging offset, default 0
limitintNPage size, default 20, maximum 200

Return Parameters ​

NameTypeRequiredDescription
codeintY0 means success
msgstringYError description for the code
totalintYTotal number of matching activities
listarrayYActivities
list[].activity_idstringYActivity ID
list[].activity_namestringYActivity name
list[].start_timeintYStart of the usage period, Unix seconds
list[].end_timeintYEnd of the usage period, Unix seconds
list[].statusstringYnot_started, in_progress, ended or cancelled
list[].currencystringYCurrency
list[].game_idstringYGame bound to the activity
list[].bet_countintYTotal number of free rounds played
list[].bet_amountstringYTotal bet amount of the free rounds played
list[].reward_amountstringYTotal payout of the free rounds played
list[].total_send_countintYTotal number of free rounds given out
list[].total_player_countintYNumber of players who received free rounds

Sample ​

Http Request
    Post Method
    URL : {Api_Address}/merchant/activity/list?mid=1697028447&sign=...&ts=1713768205
    Content-Type:application/json
    {"activity_id":"act_freebet456789","offset":0,"limit":20}

Http Response(success)
    {"code":0,"msg":"","total":1,"list":[{"activity_id":"act_freebet456789","activity_name":"Welcome bonus","start_time":1750377600,"end_time":1750895999,"status":"in_progress","currency":"PHP","game_id":"10000","bet_count":3,"bet_amount":"0.6","reward_amount":"1.5","total_send_count":10,"total_player_count":2}]}