blob: 1abfaba5cec238d0a11b784575e4c416c8d5ecf0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
# LeaderboardWinner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rank** | **number** | The user\'s final rank in the leaderboard | [default to undefined]
**freq** | [**LeaderboardFrequency**](LeaderboardFrequency.md) | The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 | [default to undefined]
**board_code** | [**LeaderboardCode**](LeaderboardCode.md) | The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts | [default to undefined]
**country_iso** | **string** | The country this leaderboard is for. | [default to undefined]
**issued** | **string** | When the prize was issued. | [default to undefined]
**bpuid** | **string** | product_user_id | [default to undefined]
**description** | **string** | | [default to undefined]
**amount** | **number** | (USD cents) The reward amount | [default to undefined]
**amount_str** | **string** | The amount as a formatted string in USD. Can be displayed to the user. | [default to undefined]
**contest_start** | **string** | When the leaderboard started | [default to undefined]
**contest_end** | **string** | When the leaderboard ended | [default to undefined]
## Example
```typescript
import { LeaderboardWinner } from './api';
const instance: LeaderboardWinner = {
rank,
freq,
board_code,
country_iso,
issued,
bpuid,
description,
amount,
amount_str,
contest_start,
contest_end,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
