LogoLogo
HomepageCase studiesBook a demo
Technical Guide
Technical Guide
  • Introduction
  • Getting Started Guide
    • Authentication
    • Member Registration Configuration
    • Add Webhook
    • Add Member
    • Create Campaign
    • Add Transaction
    • Add Custom Event Schema
    • Create Achievement
    • Add Custom Event
  • Terms Reference
  • Backward Compatibility Policy
  • API Reference
  • Postman Collection
  • User Guide
  • Integration
    • Introduction
    • Overview of Integration Methods
    • Tools and Technologies
    • Integration Examples
      • Lambda
      • Zapier
      • AWS EventBridge
      • Kafka
  • API Fundamentals
    • Overview
    • Environments Capabilities
    • How to Query
    • Limits
    • Best Practices
  • Authentication
    • Admin Token
    • Access Token (API Key)
    • Enabling SSO Login
      • Okta
      • Microsoft Entra ID
  • Webhooks
    • Overview
    • Best Practices
  • S3 Bucket Data exports
    • Overview
    • Set Up S3 Bucket Integration
    • Data Structure and Types
      • Achievements
      • Achievement Usage
      • Campaigns
      • Campaign Calculated Effect Result
      • Campaign Execution
      • Custom Events
      • Members
      • Rewards
      • Rewards Redemption
      • Tiers
      • Transactions
      • Tenants
      • Unit Transfers
Powered by GitBook
On this page

Was this helpful?

  1. S3 Bucket Data exports
  2. Data Structure and Types

Rewards

Last updated 20 days ago

Was this helpful?

The Rewards file contains information about the rewards configured in Open Loyalty.

A sample file is provided below:

Available Data:

  • rewardId: Unique ID of the reward

  • tenantId: ID of the tenant where the reward is created

  • type: Type of the reward

  • name: Name of the reward

  • brandName: Brand name details

  • levels: ID's of the tiers the reward is targeted to

  • levelNames: Names of the tiers the reward is targeted to

  • segments: ID's of the segments the reward is targeted to

  • segmentNames: Names of the segments the reward is targeted to

  • categories: ID's of the categories the reward is targeted to

  • categoryNames: Names of the categories the reward is targeted to

  • active: Status indicating if the reward is active (true = 1 / false = null)

  • costInPoints: Reward's cost in points

  • activity: Time period when the reward is active

  • visibility: Time period when the reward is visible

  • tax: Tax value

  • taxPriceValue: Tax price value

  • price: Price of the reward

  • labels: Custom attributes set for the reward

  • featured: Featured flag of the reward

  • public: Public flag of the reward

  • usageLimit: Limitation of the reward's redemption

  • fulfillmentTracking: Tracking of the reward's redemption

  • createdAt: Date when the reward was created

  • pointValue: Point value of the rewards

  • daysInactive: How long is the coupon pending for

  • daysValid: How long is the coupon valid for

  • couponGenerator: Rules set for the coupon generator

  • couponValue: Value of a coupon (for static coupons)

  • usageLeft: Number of rewards left

  • dateValid: Custom date when the reward should expire

7KB
rewards_all_until_2025_03_06.csv