Questera AI
  • Getting Started
    • Welcome to Questera Documentation
      • Overview of Questera
      • Why Choose Questera ?
      • Key Features & Benefits
      • How does it work?
  • Questera AI Platform
    • Data
      • Connect Data & Models
        • Data Ingestion
          • Snowflake
          • Amazon Redshift
          • Google BigQuery
          • Microsoft Azure
          • CSV
          • ESP (Email Service Provider)
          • CRM
        • Configure Models
          • Open AI
    • Dataset
      • Connecting an external data source
      • Uploading your own file
    • Campaigns
      • Channels Supported in Questera
        • UI Campaigns
        • Email Campaigns
        • SMS Campaigns
        • Push Notifications Campaigns
        • In-App Messages Campaigns
        • WhatsApp Campaigns
      • Campaigns in Questera: Drive Growth Across Every Touchpoint
      • Omnichannel Marketing with Questera AI
      • Why Questera’s AI-Driven Approach Wins?
    • Scores & Signals
    • Audience & segment
      • How to work with Users List
      • Create and Manage Segments
      • AI Audience Segments
    • AI Agents
      • What are AI Agents?
      • Types of AI Agents
        • ELMA - Email Lifecycle Marketing Agent
        • GRETA - Growth Engineering Agent
        • SEGA - Intelligent Segmentation Agent
        • OMNIA - Omni-Channel Journey Creator Agent
        • GIA - Data Analysis & Graphical Interpretation Agent
        • SARA - Smart Ads Retargeting Agent
        • BECCA - Personalized Email Content Agent
        • LEXA - Language Optimization Agent
      • Create & Configure an Agents
        • Create your own marketing agents
        • Chat with Agents
    • Analytics & Reporting
      • Analytics
        • Overview of Analytics.
          • Dashboard Walkthrough
          • Add dashboard
          • Chat with data
    • Playground
      • Simulating User Interactions.
        • Test and Run Campaigns
    • AI Variants
    • Journeys
      • How to Create a Journey
    • Track & Measurements
      • In-App Events
        • How to create and manage an in-App Event
      • Webhook & Alerts
        • How to create and manage Webhook & alters
      • User Attributes
        • How to create a user attribute
      • Feature Flags
        • How to add a feature flag
      • Signal
        • How to add signal
      • Counters
        • How to create and manage counter
    • Workflow
      • How to Create a Workflow in Questera
    • AI Flows
    • Settings in Questera
  • Questera AI SDKs
    • SDK Component Categories
      • Onboarding
      • Engagement
      • User Assistance
      • Expansion
      • Miscellaneous
    • All Components
      • Onboarding
        • Onboarding Quiz
        • Login Component
      • Gamified Engagement
        • Rewards & Loyalty Component
        • Challenges
        • Leaderboard
        • Badges
        • Spin The Wheel
        • Scratch The Card
        • Gamified Quiz
        • Streaks
        • Dynamic Membership
      • Education
        • User Guides
        • Tooltips
        • AI Help Hub & Assistant
      • Popups
        • Special Offers
        • Upsells & Cross Sells
        • Product Recommendations
        • Celebrations
        • Alerts
      • AI Search
      • User Feedback
      • Surveys
      • Referrals
      • Banners
      • Pricing & Payments
      • Embedded Analytics
    • React SDK Components
      • Onboarding
        • Onboarding Component
        • Get Started Component
        • Tutorial/Quest List Component
        • Walk Through Component
      • Gamification
        • Challenges Component
        • DailyStreak Component
        • Leaderboard Component
        • GamifiedQuiz component
      • User Assistance
        • Feedback Workflow Component
        • Inline Feedback Component
        • Survey Component
        • Search Bar Component
        • Help Hub Component
        • CreditsPopup Component
      • Expansion
        • Referral Components
        • Cross-Selling Component
      • Miscellaneous
        • Confetti Component
        • Alert Component
        • Login Component
        • One to one Survey Component
        • Pricing & Payment Component
        • Badge Component
        • Toast Service
      • Survey
        • User Experience Feedback Survey
        • Feature Usage Survey
        • Customer Satisfaction Surveyy
        • Net Promoter Score
        • Onboarding Experience Survey
        • Customer Support Satisfaction Survey
      • Embedded Analytics
        • Line Chart
        • Scatter Chart
        • Combo Bar/Line
        • Stacked Bar Chart
        • Horizontal Bar Chart
        • Stepped Line Chart
        • Pie chart
        • Doughnut Chart
        • Multi Series Pie
        • Bubble Chart
        • Floating Bar Chart
    • React Native SDK Components
      • Onboarding
        • Embedded Onboarding ToolTip
        • Announcement Banners
        • Onboarding Component
        • Get Started Component
        • Quest List Component
      • Gamification
        • Challenges Component
        • Daily Streak Component
        • Leaderboard Component
        • Quiz component
      • User Assistance
        • HelpHub
        • Feedback Workflow Component
        • General Feedback Component
        • Inline Feedback Component
        • Credits Popup Component
      • Expansion
        • Cross-Selling
        • Share With friends
        • Referral
      • Miscellaneous
        • Spotlight Searc
        • Modal
        • Login Component
        • Membership Card
        • Badges
        • Pricing
        • Survey Form
        • Banner
        • Carousel
        • Tutorial
        • Daily Check-in Credit
    • No Code SDK Components
      • HelpHub
      • Feedback Workflow Component
    • Flutter SDK Components
      • Onboarding
        • Onboarding Quiz - Multi page Component
        • Onboarding Quiz - Single page Component
        • Get Started Component
        • Tutorial/Quest List Component
      • User Assistance
        • Feedback Workflow
        • Help Hub Component
        • Inline Feedback Component
        • Spotlight Search Component
        • Survey component
      • Gamification
        • Daily Streak Component
        • Leaderboard Component
        • Gamified Quiz Component
      • Expansion
        • Referral Component
        • Cross-Selling Component
      • General Components
        • Login Component
    • Rest APIs
      • Data Module
        • Data Object
      • Entity Module
        • Entity Object
      • User Module
        • User Object
      • Gamification
        • Badge Object
        • Web3 Module
          • Dynamic NFT Object
        • Skills Module
          • Skills Object
        • Levels Module
          • Levels Object
  • Integrations
    • Email
      • Mailchimp
      • Klaviyo
      • Mailmodo
      • Mailjet
      • Brevo (SendInBlue)
      • Constant Contact
      • Elastic Email
      • ApolloIo
      • Google OAuth
      • Instantly
      • Loops
      • AWS SES
      • SendGrid
      • Hubspot
      • Activecampaign
      • One Signal
      • Attio
    • Customer data platforms
      • Segment
      • Shopify
      • Salesforce
    • Workflow automation & ETLs
      • Zapier
    • Analytics & business intelligence
      • Mixpanel
      • Amplitude
      • Heap
      • Posthog
      • Snowflake
      • Google BigQuery
      • Clay
      • Outreach
      • Salesloft
      • Smartlead
    • Data ware house
      • Redshift
      • Microsoft Azure
    • Task management
      • Clickup
      • Jira
    • FAQ
  • recipes
    • Greta
      • SaaS Subscription
        • Activation
        • Conversion
        • Retention
      • SaaS Credit-Based
        • Activation
        • Conversion
        • Retention
        • Engagement
      • Ed-Tech
        • Activation
        • Conversion
        • Retention
        • Engagement
      • Gaming Apps
        • Activation
        • Conversion
        • Retention
        • Engagement
      • E-Commerce
        • Activation
        • Conversion
        • Retention
    • Elma
      • SaaS Subscription
        • Activation
        • Conversion
        • Retention
        • Engagement
      • SaaS Credit-Based
        • Activation
        • Conversion
        • Retention
        • Engagement
      • E-Commerce
        • Activation
        • Conversion
        • Retention
        • Engagement
  • GRETA
    • How to create your first project using Greta?
    • Playground
Powered by GitBook
On this page
  1. Questera AI SDKs
  2. Rest APIs
  3. Gamification

Badge Object

Breakdown of how Badge Object looks like. It will be the same within every Quest API.

PreviousGamificationNextWeb3 Module

Field
Type
Description

badgeId

string

Badge Id for the specific badge

entityId

string

Entity Id for which badge belongs to

name

string

Name of the badge

description

string

More details regarding the badge

imageIPFS

string

IPFS hash for the image. In order to use it append or any other gateway to the IPFS hash.

xp

number

XP is the # of experience points that every user will get while claiming this badge

visibility

string

Indicates if the badge is open to be claimed by anyone of set of specific users. (Values include - "OPEN" & "LIMITED")

type

string

Indicates the type of badge, currently feel free to just pass "NONE" in here.

remainingCount

number

For open badges, it determines the number of users that can

badgeContractTokenId

string

Token Id of the badge soulbound nft from the ERC1155 contract address for the entity

endsAt

number

Depicts the time when badge claiming expires. Value is in ms since 1970

claimStatus

string

It currently can have 3 values "CLAIMED" or "UNCLAIMED" or "NOT_WHITELISTED"

claimed

boolean

Bool value indicating if user claimed the badge or not

inDyNFT

boolean

Bool value indicating if this badge is added into the users Dynamic Avatar NFT for the entity.

skills

array

Contains array of skills and respective scores that a user will earn while claiming this badge. Every item in the array will have "skillId" and "score"

proofType

string

Indicates the type of the badge like Proof of Appreciation, Proof of Engagement, Proof or Certification etc

typeData

array

Array of extra misc information that you want to store with your badge

ipfs.io/ipfs/