diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/TopNOfferWall.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/TopNOfferWall.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/TopNOfferWall.md b/jb-ui/src/api_fsb/docs/TopNOfferWall.md new file mode 100644 index 0000000..5652aa0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNOfferWall.md @@ -0,0 +1,31 @@ +# TopNOfferWall + +An offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. Offerwall code: `45b7228a7` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | Total opportunities available for specific bpuid respondent and parameters. This value changes frequently and can be used to determine if a respondent has potential tasks available, regardless of the offerwall type being requested. If the value is 0, no buckets will be generated. | [default to undefined] +**attempted_live_eligible_count** | **number** | Number of currently live opportunities for which the respondent meets all eligibility criteria but is excluded due to a prior attempt. Only includes surveys that are still live and otherwise eligible; does not include previously attempted surveys that are no longer available. | [optional] [default to 0] +**buckets** | [**Array<TopNBucket>**](TopNBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] +**payout_format** | **string** | The format describing the str representation of a payout. Typically, this would be displayed to a user. The payout_format is similar to python format string with a subset of functionality supported. Only float with a precision are supported along with an optional comma for a thousands separator. In addition, a mathematical operator can be applied, such as dividing by 100. Examples are shown assuming payout = 100 (one dollar). - \"{payout*10:,.0f} Points\" -> \"1,000 Points\" - \"${payout/100:.2f}\" -> \"$1.00\" | [default to undefined] + +## Example + +```typescript +import { TopNOfferWall } from './api'; + +const instance: TopNOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, + payout_format, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |