A Payout Group (AKA Cashflow Group) consists of a set of Rules which specify conditions that must pass in order for an event such as a conversion to receive a specific payout. For instance, a Payout Group may have a Rule that requires the conversion to be for specific countries, or from specific browsers. For more information, see help.tune.com/hasoffers/payout-revenue-groups/
Name | Type | Description |
---|---|---|
id | Integer | ID of A unique object for the Payout Group This parameter is non-writable |
name | String | The unique name of the Payout Group |
description | Nullable String | A description of the Payout Group, typically giving an overview of its Rules |
rules | Array | An array of Payout Group Rules that define conditions that must be met in order to receive a certain payout. Rules consist of a field (e.g. country or aff_sub1), operator (e.g. STARTS_WITH), value (e.g. "Foo"), and optional negation (true/false). In order for a Rule to be satisfied, the event must match on each field + operator + value combination defined in the rules. For example, a rule with "field" set to "country", operator of "IN", and value of [US, CA], would only be satisfied if the conversion originated from the United States or Canada. |