# LoyaltyOfferProgramsByPidRewardsRid Get reward information Returns reward information. - Catalog: `Brevo` - Schema: `Reward` This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `LoyaltyOfferProgramsByPidRewardsRid`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `pid` | `` | ☑ | | Loyalty Program ID | | `rid` | `` | ☑ | | Reward ID | | `version` | `` | ☐ | | Version (Values: active, draft) | ## Columns of Table Function The columns of the table function `LoyaltyOfferProgramsByPidRewardsRid` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `attributionPerConsumer` | `int64` | | ☐ | Maximum number of times a consumer can be attributed this reward | | `balanceDefinitionId` | `guid` | | ☐ | Unique identifier for the balance definition | | `code` | `varchar2` | | ☐ | Unique code for the reward | | `codeCount` | `int64` | | ☐ | Total number of codes generated | | `codeGeneratorId` | `guid` | | ☐ | Unique identifier for the code generator | | `codePoolId` | `guid` | | ☐ | Unique identifier for the code pool | | `config` | `varchar2` | | ☐ | Configuration settings for the reward | | `createdAt` | `datetime` | Creation Date | ☐ | Timestamp when the reward was created | | `disabledAt` | `datetime` | | ☐ | Disabled date of the reward | | `endDate` | `datetime` | End Date | ☐ | End date of the reward validity | | `expirationDate` | `datetime` | | ☐ | Expiration date of the reward | | `expirationModifier` | `varchar2` | | ☐ | Select startOfPeriod to configure rewards expiry on start of day/week/month/year. Select endOfPeriod to configure reward expiry on end of day/week/month/year, else select noModification | | `expirationUnit` | `varchar2` | | ☐ | Unit of time for the rewards's availability (e.g., day/week/month/year). | | `expirationValue` | `int64` | | ☐ | Number of days/weeks/month/year for reward expiry | | `generator_createdAt` | `varchar2` | | ☐ | Timestamp when the reward was created | | `generator_description` | `varchar2` | | ☐ | Public facing description of the reward | | `generator_id` | `guid` | | ☐ | Unique identifier for the reward | | `generator_name` | `varchar2` | | ☐ | Name of the reward | | `generator_pattern` | `varchar2` | | ☐ | Generated pattern | | `generator_updatedAt` | `datetime` | | ☐ | Timestamp when the reward was created | | `id` | `guid` | ID | ☐ | Unique identifier for the reward | | `loyaltyProgramId` | `guid` | | ☐ | Id of the loyalty program to which the current reward belongs to | | `meta` | `varchar2` | | ☐ | Additional data for reward definition | | `name` | `varchar2` | Name | ☐ | Name of the reward | | `publicDescription` | `varchar2` | | ☐ | Public description for the reward | | `publicImage` | `varchar2` | | ☐ | Public Image for the reward | | `publicName` | `varchar2` | | ☐ | Public name for the reward | | `redeemPerConsumer` | `int64` | | ☐ | Defines the redeem limit for the consumer | | `rewardConfigs_attribution` | `varchar2` | | ☐ | Attribution config of the reward | | `rewardConfigs_code` | `varchar2` | | ☐ | Code config of the reward | | `rewardConfigs_value` | `varchar2` | | ☐ | Value config of the reward | | `rule_condition_op` | `varchar2` | | ☐ | Selected operator for the rule | | `rule_createdAt` | `varchar2` | | ☐ | Timestamp when the rule was created | | `rule_description` | `varchar2` | | ☐ | Description of the rule | | `rule_event_name` | `varchar2` | | ☐ | Name of the event | | `rule_event_source` | `varchar2` | | ☐ | Source of the event | | `rule_isInternal` | `char` | | ☐ | Metric to identify if it's an internal rule or not | | `rule_loyaltyProgramId` | `varchar2` | | ☐ | Loyalty Program id to which current rule is associated | | `rule_loyaltyVersionId` | `int64` | | ☐ | Loyalty Version id to which current rule is associated | | `rule_meta` | `varchar2` | | ☐ | Additional data to define the rule | | `rule_name` | `varchar2` | | ☐ | Rule name | | `rule_ruleId` | `varchar2` | | ☐ | Unique identifier for the rule | | `rule_ruleType` | `varchar2` | | ☐ | Type of the rule | | `rule_updatedAt` | `varchar2` | | ☐ | Timestamp when the rule was updated | | `startDate` | `datetime` | Start Date | ☐ | Start date of attribution of the reward | | `subtractBalanceDefinitionId` | `varchar2` | | ☐ | Id of the selected balance while redeeming / attributing a reward | | `subtractBalanceStrategy` | `varchar2` | | ☐ | Strategy of the Balance while redeeming / attributing a reward | | `subtractBalanceValue` | `int64` | | ☐ | Amount of balance to be selected while redeeming / attributing a reward | | `subtractTotalBalance` | `char` | | ☐ | Value to indicate to subtract full balance or not | | `totalAttribution` | `int64` | | ☐ | Defines the limit to which a consumer can attribute a reward | | `totalRedeem` | `int64` | | ☐ | Defines the limit to which a consumer can redeem a reward | | `triggerId` | `varchar2` | | ☐ | Id of the Rule to be updated for that reward | | `unit` | `varchar2` | | ☐ | Selected unit of the balance | | `updatedAt` | `varchar2` | | ☐ | Timestamp for when this reward was last updated. | | `value` | `decimal` | Value | ☐ | Value of metric in selected config for reward definition | | `valueType` | `varchar2` | | ☐ | Type of config selected for reward definition |