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

Data Structure and Types

Learn more how data is organized in AWS S3 Bucket

Last updated 2 months ago

Was this helpful?

The export frequency is set to daily to ensure consistent and timely access to the data for all our customers.

There is one report set for the environment, regardless of the number of tenants created. There is a unique identifier (tenant_id) for all the reports. Then you can create pipelines to further split the data per tenant.

Overall Structure

  • analytics/ This is the main folder (or “prefix”) within the bucket. All data related to analytics is organized under this folder.

Subfolders under analytics/

  1. Achievements/ Contains CSV data files related to achievements. These might include records of user milestones or progress indicators, as well as overall configuration of the achievements. You can find out more about the file structure stored in this folder in these articles: Achievements Achievement Usage

  2. Campaigns/ Contains CSV data files related to campaigns, such as configuration files or performance metrics. You can find out more about the file structure stored in this folder in these articles: Campaigns Campaign Execution Campaign Calculated Effect Result

  3. CustomEvent/ Contains CSV data files related to all the custom events registered in the system. You can find out more about the file structure stored in this folder in this article: Custom Events

  4. Members/ Contains CSV data files related to all the members registered in the system, and the updates on their profiles. You can find out more about the file structure stored in this folder in this article: Members

  5. Points/ Contains CSV data files related to units accumulated by users, as well as used and expired transfers. You can find out more about the file structure stored in this folder in this article: Unit Transfers

  6. Rewards/ Contains CSV data files related to available rewards and redemption histories. You can find out more about the file structure stored in this folder in these articles: Rewards Rewards Redemption

  7. Tenant/ Contains CSV data files related to all the tenants (storeCodes) created in the system. You can find out more about the file structure stored in this folder in this article: Tenants

  8. Tiers/ Contains CSV data files related to different tier levels (e.g., Bronze, Silver, Gold) and the rules or requirements for each tier. You can find out more about the file structure stored in this folder in this article: Tiers

  9. Transactions/ Contains CSV data files related to all the transactions registered in the system. You can find out more about the file structure stored in this folder in this article: Transactions