This operation retrieves branch financial view data for a specified time interval.
Request
| PARAMETER | DESCRIPTION | FORMAT | EXAMPLE |
| PartnerID | ID of partner Unique ID associated with each customer | GUID | D61A14AE-0A0C-464B-B7AB-5900BE7462F9 |
| Sign | Parameters partnerID, branches, timeFrom, timeTo (for more information, see Creating Data Sign) | string(64) | 5E0A0349AE36AD67CD21D891AB124CCE8CC4171C5BD7EF5B26FCA86DB71F500A |
| Branch | The customer’s branch. | string | Branch1 |
| TimeFrom | The start of the time interval | DateTime | 2015-01-20T00:00:00 |
| TimeTo | The end of the time interval | DateTime | 2015-01-23T00:00:00 |
Request example:
REST JSON
POST https://staging.tomhorngames.com/services/gms/RestCustomerReportService.svc/GetBranchSummary HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 123456
Host: staging.tomhorngames.com
{
"PartnerID": "C77BB500-7E9A-4214-BD3C-605D6D2F91D9",
"Sign": "3eabb82d8633391137cd64f5c0ac68ea38ca61be90e7c8e9b91105a37048358c",
"Branch": "a1",
"TimeFrom": "2022-01-01T00:00:00",
"TimeTo": "2022-06-14T00:00:00"
}
SOAP
POST https://staging.tomhorngames.com/services/gms/CustomerReportService.svc HTTP/1.1
Host: staging.tomhorngames.com
Content-Type: text/xml; charset="utf-8"
SOAPAction: "http://tomhorn.eu/crservice/ICustomerReportService/GetBranchSummary"
Content-Length: 123456
<GetBranchSummaryRequest>
<PartnerID>D61A14AE-0A0C-464B-B7AB-5900BE7462F9</PartnerID>
<Sign>5E0A0349AE36AD67CD21D891AB124CCE8CC4171C5BD7EF5B26FCA86DB71F500A</Sign>
<Branch>Branch1<Branch>
<TimeFrom>2015-01-20T00:00:00</TimeFrom>
<TimeTo>2015-01-23T00:00:00</TimeTo>
</GetBranchSummaryRequest>
Response
| PARAMETER | DESCRIPTION | FORMAT | EXAMPLE |
| Code | Result codes: 0, 1, 11, 12, 1001, 1002, 1006 , 1013, 1016 (for more information, see Result Codes) | integer | 0 |
| Message | Description of the error, if one has occurred. This value is filled only in the event that an error takes place. | string | The specified session was not found |
| TimeFrom | The start of the time interval | DateTime | 2015-01-20T00:00:00 |
| TimeTo | The end of the time interval | DateTime | 2015-01-23T00:00:00 |
| Summary | Financial data for the branch. This property is set only if the result code is 0 (success). | ||
| BranchName | The name of the branch. | string | Customer01 |
| Rows | List of currency financial views. This property is set only if the result code is 0 (success). | ||
| Total | Total currency financial view. This property is set only if the result code is 0 (success). | ||
| CurrencyCode | Code of currency. | string | EUR |
| OverallSummary | Overall financial view. | ||
| Deposits | Sum of player's deposits. | decimal | 28.56 |
| Withdrawals | Sum of player's withdrawals. | decimal | 20.19 |
| Hold | Calculated as Deposits – Withdrawals. | decimal | 8.37 |
| PercentageHold | Percentage of Hold calculated as Hold / Deposits. | decimal | 29.31 |
| Playthrough | Calculated as Bets / Deposits. | decimal | 0.36 |
| GamesSummary | Financial data for games. | ||
| UsersCount | Count of users. | integer | 10 |
| ActiveUsers | Count of active users. | integer | 2 |
| Bets | Sum of all bets in session. | decimal | 10.35 |
| Wins | Sum of all wins in session. | decimal | 8.21 |
| Profit | Difference between Bets and Wins (Bets – Wins). | decimal | 2.14 |
| PercentageProfit | Calculated as fraction Profit / Bets (in %). | decimal | 20.68 |
| PercentageTotal | Profit from all players in selected time. | decimal | 32.11 |
| BetsCount | Count of all bets in session. | integer | 12 |
| WinsCount | Count of all wins in session. | integer | 8 |
| PercentageWins | Calculated as fraction WinsCount / BetsCount (in %). | decimal | 60.67 |
| AverageProfit | Calculated as fraction Profit / BetsCount, shows average profit per 1 bet. | decimal | 0.18 |
| MaxBet | The highest bet. | decimal | 1.00 |
| AverageBet | Fraction Bets / BetsCount shows the average amount of 1 Bet. | decimal | 0.75 |
| MaxWin | The highest win. | decimal | 3.00 |
| AverageWin | Calculated as fraction Wins / WinsCount, shows the average value of 1 win. | decimal | 1.25 |
| ProfitUser | Calculated as: Profit / Active users. | decimal | 1.07 |
Response example:
REST JSON
{
"Code": 0,
"Message": null,
"Summary": {
"BranchName": "b_THETestRest_a1",
"Rows": [
{
"CurrencyCode": "USD",
"OverallSummary": {
"Deposits": 0.0000,
"GamesSummary": {
"ActiveUsers": 1,
"AverageBet": -1,
"AverageProfit": -1,
"AverageWin": -1,
"Bets": 5.9000,
"BetsCount": 6,
"MaxBet": -1,
"MaxWin": 1.0000,
"PercentageProfit": -1,
"PercentageTotal": -1,
"PercentageWins": -1,
"Profit": -1,
"ProfitUser": -1,
"UsersCount": 1,
"Wins": 1.0000,
"WinsCount": -1
},
"Hold": -1,
"PercentageHold": -1,
"Playthrough": -1,
"Withdrawals": 0.0000
}
}
],
"Total": {
"CurrencyCode": null,
"OverallSummary": {
"Deposits": 0.000000000000,
"GamesSummary": {
"ActiveUsers": 1,
"AverageBet": -1,
"AverageProfit": -1,
"AverageWin": -1,
"Bets": 5.900000000000,
"BetsCount": 6,
"MaxBet": -1,
"MaxWin": 1.0000,
"PercentageProfit": -1,
"PercentageTotal": -1,
"PercentageWins": -1,
"Profit": -1,
"ProfitUser": -1,
"UsersCount": 2,
"Wins": 1.000000000000,
"WinsCount": -1
},
"Hold": -1,
"PercentageHold": -1,
"Playthrough": -1,
"Withdrawals": 0.000000000000
}
}
},
"TimeFrom": "2022-01-01T00:00:00",
"TimeTo": "2022-06-14T00:00:00"
}
SOAP
<GetBranchSummaryResponse>
<Code>0</Code>
<Message></Message>
<TimeFrom>2013-11-18T12:00:00</TimeFrom>
<TimeTo>2013-11-19T12:00:00</TimeTo>
<Summary>
<BranchName>Customer01</BranchName>
<Rows>
<CurrencySummary>
<CurrencyCode>EUR</CurrencyCode>
<OverallSummary>
<Deposits>28.56</Deposits>
<Withdrawals>20.19</Withdrawals>
<Hold>8.37</Hold>
<PercentageHold>29.31</PercentageHold>
<Playthrough>0.36</Playthrough>
<GamesSummary>
<Bets>10.35</Bets>
<Wins>8.21</Wins>
<Profit>2.14</Profit>
<PercentageProfit>20.68</PercentageProfit>
<PercentageTotal>32.11</PercentageTotal>
<BetsCount>12</BetsCount>
<WinsCount>8</WinsCount>
<PercentageWins>60.67</PercentageWins>
<AverageProfit>0.18</AverageProfit>
<MaxBet>1.00</MaxBet;
<AverageBet>0.75</AverageBet;
<MaxWin>3.00</MaxWin;
<AverageWin>1.25</AverageWin;
</GamesSummary>
</OverallSummary>
</CurrencySummary>
</Rows>
<Total>
<CurrencyCode>EUR</CurrencyCode>
<OverallSummary>
<Deposits>28.56</Deposits>
<Withdrawals>20.19</Withdrawals>
<Hold>8.37</Hold>
<PercentageHold>29.31</PercentageHold>
<Playthrough>0.36</Playthrough>
<GamesSummary>
<Bets>10.35</Bets>
<Wins>8.21</Wins>
<Profit>2.14</Profit>
<PercentageProfit>20.68</PercentageProfit>
<PercentageTotal>32.11</PercentageTotal>
<BetsCount>12</BetsCount>
<WinsCount>8</WinsCount>
<PercentageWins>60.67</PercentageWins>
<AverageProfit>0.18</AverageProfit>
<MaxBet>1.00</MaxBet;
<AverageBet>0.75</AverageBet;
<MaxWin>3.00</MaxWin;
<AverageWin>1.25</AverageWin;
</GamesSummary>
</OverallSummary>
</Total>
</Summary>
</GetBranchSummaryResponse>
Comments
0 comments
Article is closed for comments.