summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md
diff options
context:
space:
mode:
Diffstat (limited to 'jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md')
-rw-r--r--jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md b/jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md
new file mode 100644
index 0000000..9216bbf
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md
@@ -0,0 +1,29 @@
+# MarketplaceOfferwall
+
+Returns buckets grouped by marketplace, one per marketplace, with the tasks ordered by quality. Offerwall code: `5fa23085`
+
+## 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<MarketplaceBucket>**](MarketplaceBucket.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]
+
+## Example
+
+```typescript
+import { MarketplaceOfferwall } from './api';
+
+const instance: MarketplaceOfferwall = {
+ id,
+ availability_count,
+ attempted_live_eligible_count,
+ buckets,
+ offerwall_reasons,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)