ThrillOffice Reporting API Documentation (0.0.14)

Download OpenAPI specification:

License:

The ThrillOffice Reporting API is exclusively used by ThrillTech BackOffice.

Health

Health check endpoint

Responses

Response samples

200

Content type

application/json

{"version": "string"
}

Reports

Adjustments

query Parameters

id	string or null Filter on Report ID
data.brand_id	string or null Filter on Brand ID
instance_id	string or null Filter on Jackpot Instance ID
instance_version	string or null Filter on Instance Version
data.pot_id	string or null Filter on Instance Pot ID
data.username	string or null Search on Username
data.reason	string or null Search on Reason
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms
sort_field	string or null Field to sort the report data on
sort_diection	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC
page	integer or null <int32> The page of results to retrieve
limit	integer or null <int32> The number of items per page

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"timestamp": 0,
"adjustment_id": "string",
"adjustment_type": "string",
"instance_id": "string",
"instance_version": 0,
"username": "string",
"jackpot_currency": "string",
"pot_id": "string",
"pot_amount_before": 0.1,
"adjustment_amount": 0.1,
"reason": "string"
}
]

Total contributions report

query Parameters

instance_id	string or null Filter on Jackpot Instance ID
data.brand_id	string or null Filter on Players Brand ID
data.currency_player	string or null Filter on Players Currency
data.player_country	string or null Filter on Players Country
data.source_id	string or null Filter on Source Id
data.source_name	string or null Filter on Source Name
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms

Responses

Response samples

200
400
401
417
500

Content type

application/json

{"brand_id": "string",
"instance_id": "string",
"instance_currency": "string",
"total_win_amount": 0.1,
"total_win_count": 0,
"total_hold_amount": 0.1,
"total_contribution_amount": 0.1,
"total_seed_deficit_amount": 0.1,
"total_operator_contribution_amount": 0.1,
"total_contribution_count": 0
}

Contributors

query Parameters

player_id	string or null Search by internal player id
brand_id	string or null Filter by player brand
ext_player_id	string or null Search by external player id
instance_id	string or null Filter on Jackpot Instance ID
opted_in	string or null Filter on Status
player_brand_id	string or null Filter on Player Brand ID
sort_field	string or null Field to sort the report data on
sort_diection	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC
page	integer or null <int32> The page of results to retrieve
limit	integer or null <int32> The number of items per page

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"instance_id": "string",
"player_id": "string",
"ext_player_id": "string",
"player_brand_id": "string",
"preferred_contribution_value": 0.1,
"preferred_contribution_currency": "string",
"contribution_count": 0,
"contribution_value": 0.1,
"pot_contributions": {"property1": {"contribution_count": 0,
"contribution_value": 0.1
},
"property2": {"contribution_count": 0,
"contribution_value": 0.1
}
},
"opted_in": true,
"last_updated": 0
}
]

Instance Reconciliation

query Parameters

instance_id	string or null Filter on Jackpot Instance ID
owner_id	string or null Filter on Jackpot Owner ID
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"instance_id": "string",
"month": 0,
"name": "string",
"owner_id": "string",
"seed": 0.1,
"value": 0.1,
"pots_liabilities": [{"id": "string",
"seed": 0.1,
"value": 0.1
}
],
"contributions": 0,
"ggr": 0.1,
"deficit": 0.1,
"timestamp": 0
}
]

Rejected Bet Status

query Parameters

id	string or null Filter on Report ID
data.brand_id	string or null Filter on Brand ID
instance_id	string or null Filter on Jackpot Instance ID
instance_version	string or null Filter on Instance Version
data.player_id	string or null Search on Player ID
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms
sort_field	string or null Field to sort the report data on
sort_diection	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC
page	integer or null <int32> The page of results to retrieve
limit	integer or null <int32> The number of items per page

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"timestamp": 0,
"instance_id": "string",
"instance_version": 0,
"data": {"player_id": "string",
"brand_id": "string",
"reasons": {"property1": 0,
"property2": 0
},
"total_rejections": 0
}
}
]

Top players report

query Parameters

metadata.instance_id	string or null Filter on Jackpot Instance ID
metadata.brand_id	string or null Filter on Players Brand ID
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms

Responses

Response samples

200
400
401
417
500

Content type

application/json

{"winners": [{"player_id": "string",
"value": 0.1,
"currency": "string"
}
],
"contributors": [{"player_id": "string",
"value": 0.1,
"currency": "string"
}
],
"net_contributors": [{"player_id": "string",
"value": 0.1,
"currency": "string"
}
]
}

Instances

query Parameters

id	string or null Filter on Instance ID
owner_id	string or null Filter on Instance Owner ID (operator_id:brand_id)
status	string or null Filter on Status
jackpot_type	string or null Filter on Instance Type
sort_field	string or null Field to sort the report data on
sort_diection	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC
page	integer or null <int32> The page of results to retrieve
limit	integer or null <int32> The number of items per page

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"id": "string",
"game_code": "string",
"template_id": "string",
"status": "Pending",
"name": "string",
"description": "string",
"owner_id": "string",
"version": 0,
"currency": "string",
"contribution_rules": {"opt_in_required": true,
"contribution_type": {"Fixed": 0.1
},
"contribution_values_alt": [{"currency": "string",
"value": 0.1
}
],
"max_contribution": {"max_contribution_value": "string",
"max_contribution_values_alt": [{"currency": "string",
"value": 0.1
}
],
"include_base_wager": true
},
"operator_contribution_percentage": "string",
"wager_criteria": {"min_base_wager": 0,
"min_contribution": 0
},
"allowed_brands": ["string"
],
"country_filters": {"black_list": ["string"
],
"white_list": ["string"
]
}
},
"house_pot": {"contribution_type": {"Fixed": 0.1
},
"timestamp_created": 0,
"current_value": 0.1,
"accumulated_seed_deficit": 0.1,
"total_contributions": 0,
"diversion_rules": {"target": {"External": {"endpoint": "string",
"account_id": "string"
}
},
"diversion_percentage": "string",
"flush_threshold": "string"
},
"diversion_pool": 0.1
},
"jackpot_type": "Jackpot",
"raffle_rules": {"cost_per_ticket": "string",
"cost_source": "Contribution",
"allocation_mode": "Instant",
"duration": {"Seconds": 0
},
"prize_distribution": [{"prize_percentage": "string",
"number_of_winners": 0
}
]
},
"pots": [{"id": "string",
"enabled": true,
"contribution": {"Fixed": 0.1
},
"payout_ruleset": {"main_winner_percentage": 0.1,
"admin_fee": 0.1,
"payout_rules": [{"payout_percentage": 0.1,
"rule": {"ActivePlayers": {"period_before_win": 0,
"max_number_of_payouts": 0
}
}
}
]
},
"seed_contribution": {"Fixed": 0.1
},
"seed_strategy": {"initial_seed_value": 0.1,
"min_reseed_value": 0.1,
"fund_strategy": "CollectToMinReseed",
"reseed_strategy": "Full"
},
"win_constraints": [{"AllowedSeedDeficit": "string"
}
],
"instance_count": 0,
"timestamp_created": 0,
"supports_external_trigger": true,
"is_progressive": true,
"surplus_seed": 0.1,
"contributed_amount": 0.1,
"contributed_seed": 0.1,
"seed_value": 0.1,
"current_value": 0.1,
"pot_types": [{"Time": {"start_time": 0,
"end_time": 0
}
}
],
"criteria": {"min_base_wager": 0,
"min_contribution": 0
},
"maximum_pot_value": "string",
"overflow_amount": 0.1,
"total_contributions": 0
}
],
"win_selector_strategy": "Lowest",
"total_contributions": 0,
"created": 0,
"timestamp_start": 0,
"timestamp_end": 0,
"last_updated": 0,
"active_optins_count": 0
}
]

Reports Stream

Raffle Winners Stream

query Parameters

id	string or null Filter on Report ID
instance_id	string or null Filter on Jackpot Instance ID
data.brand_id	string or null Filter on Brand ID
data.currency_jackpot	string or null Filter on Jackpot Currency
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms
sort_field	string or null Field to sort the report data on
sort_direction	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"timestamp": 0,
"instance_id": "string",
"instance_version": 0,
"brand_id": "string",
"player_id": "string",
"source_id": "string",
"source_name": "string",
"game_round": "string",
"player_currency": "string",
"jackpot_currency": "string",
"win_pot_id": "string",
"win_amount": 0.1,
"win_amount_jackpot_currency": 0.1,
"total_contributions": 0,
"win_pot_total_contributions": 0,
"seed_deficit": 0.1,
"base_wager": 0.1,
"player_contribution_jackpot_currency": 0.1,
"source_gameround_id": "string",
"community_winners": [{"player_id": "string",
"player_ext_id": "string",
"brand_id": "string",
"currency": "string",
"win_amount": "string",
"reason": "string"
}
],
"tx_debit_id": "string",
"tx_credit_id": "string"
}
]

OptIn Events Stream

query Parameters

id	string or null Filter on Report ID
data.brand_id	string or null Filter on Brand ID
instance_id	string or null Filter on Jackpot Instance ID
instance_version	string or null Filter on Instance Version
data.player_country	string or null Filter on Player Country
data.opt_in	string or null Filter on Status
data.player_id	string or null Search on Player ID
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms
sort_field	string or null Field to sort the report data on
sort_diection	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"timestamp": 0,
"instance_id": "string",
"instance_version": 0,
"player_id": "string",
"brand_id": "string",
"player_country": "string",
"opt_in": true,
"contribution_value": "string"
}
]

Transactions Stream

query Parameters

id	string or null Filter on Report ID
data.brand_id	string or null Filter on Brand ID
instance_id	string or null Filter on Jackpot Instance ID
instance_version	string or null Filter on Instance Version
name	string or null Filter on Instance Name
win_pot_id	string or null Filter on Winning Pot ID
data.player_id	string or null Search on Player ID
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms
sort_field	string or null Field to sort the report data on
sort_diection	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"timestamp": 0,
"instance_id": "string",
"instance_version": 0,
"brand_id": "string",
"player_id": "string",
"source_id": "string",
"source_name": "string",
"game_round": "string",
"player_currency": "string",
"jackpot_currency": "string",
"transaction_amount": 0.1,
"transaction_amount_jackpot_currency": 0.1,
"operator_contribution": 0.1,
"win_pot_id": "string",
"win_amount": 0.1,
"win_amount_jackpot_currency": 0.1,
"tx_debit_id": "string",
"tx_credit_id": "string"
}
]

Jackpot Winners Stream

query Parameters

id	string or null Filter on Report ID
data.brand_id	string or null Filter on Brand ID
instance_id	string or null Filter on Jackpot Instance ID
data.win_pot_id	string or null Filter on Win Pot ID
data.currency_jackpot	string or null Filter on Jackpot Currency
data.currency_player	string or null Filter on Player Currency
deficit_only	string or null Filter on deficit wins only. Boolean
community_wins	string or null Filter on comunity wins. Boolean
data.player_id	string or null Search on Player ID
date_start	integer or null <int64> Start time for the report. Tiimestamp in Unix epoch ms
date_end	integer or null <int64> End time for the report. Tiimestamp in Unix epoch ms
sort_field	string or null Field to sort the report data on
sort_direction	integer or null <int32> Direction to sort on. 1 = ASC, -1 = DESC

Responses

Response samples

200
400
401
417
500

Content type

application/json

[{"timestamp": 0,
"instance_id": "string",
"instance_version": 0,
"brand_id": "string",
"player_id": "string",
"source_id": "string",
"source_name": "string",
"game_round": "string",
"player_currency": "string",
"jackpot_currency": "string",
"win_pot_id": "string",
"win_amount": 0.1,
"win_amount_jackpot_currency": 0.1,
"total_contributions": 0,
"win_pot_total_contributions": 0,
"seed_deficit": 0.1,
"base_wager": 0.1,
"player_contribution_jackpot_currency": 0.1,
"source_gameround_id": "string",
"community_winners": [{"player_id": "string",
"player_ext_id": "string",
"brand_id": "string",
"currency": "string",
"win_amount": "string",
"reason": "string"
}
],
"tx_debit_id": "string",
"tx_credit_id": "string"
}
]