Loyi API Reference
  1. Quest
Loyi API Reference
  • Getting Started
  • Architecture
  • User
    • Users Overview
    • Create user
      POST
    • Get users
      GET
    • Get user
      GET
    • Update user
      PUT
    • Delete user
      DELETE
  • Reward
    • Rewards Overview
    • Create reward
      POST
    • Get rewards
      GET
    • Delete reward
      DELETE
    • Create entry pass code
      POST
    • Get entry pass code
      GET
    • Airdrop reward
      PUT
    • Award reward
      POST
    • Redeem rewards
      GET
  • Collection
    • Collection Overview
    • Create collection
    • Get collections
    • Get collection
    • Update collection
    • Delete collection
    • Get rewards
  • Collectible
    • Claim collectible
    • Get collectibles
  • Quest
    • Quest Overview
    • Create quest
      POST
    • Get quests
      GET
    • Get quest
      GET
    • Update quest
      PUT
    • Delete quest
      DELETE
    • Get participants
      GET
    • Accept quest
      POST
    • Submit answers
      POST
    • Get answers
      GET
  • Leaderboard
    • Leaderboard Overview
    • Get leaderboard
  • Leveling
    • Get leveling configuration
    • Configure leveling
    • Get milestone levels
    • Create milestone level
    • Get milestone level
    • Update milestone level
    • Delete milestone level
  1. Quest

Quest Overview

The quest object is a task based element of Loyi. You can create Quests to engage consumers and reward them for finishing a quest.
Currently, the following quest types are offered:
Collection Quest Quiz
Quiz Quest
Questionnaire Quiz
A Collection Quest is a task that asks the user to collect multiple collectibles from different collections. If they manage to collect all the collectibles they will unlock the reward.
A Quiz Quest is a task that asks the user to answer multiple choice questions correctly. If they manage to surpass the threshold they will unlock the reward. Otherwise, they fail to unlock the reward.
A Questionnaire Quest is a task that gets feedback from a user. They can be asked about a linear scale opinion or an open text opinion. If they answer all the questions correctly, they will unlock the reward.
Quests represent structured challenges that users complete to earn rewards. They provide gamification mechanics to engage users.
The Quest resource is a task based element of Loyi. Quests represent structured challenges that users complete to earn rewards. They provide gamification mechanics to engage users.

Quest Types#

1.
Collection Quests:
Users progress by claiming collectibles from specified collections
Linear progression through collection steps
Unlock rewards when all collectibles have been collected
2.
Quiz Quests:
Multiple-choice questions
Requires achieving a minimum score (scoreGoal) to pass
Unlock rewards when the quiz is passed
3.
Questionnaire Quests:
Survey-style questions (always passes on submission)
Linear-scale or text-based questions
Used for gathering user feedback or information
Unlock rewards when the questionnaire is completed

Key Features#

Multi-stage Progression: Track completion percentage through steps
Reward Integration: Associate multiple rewards with quest completion
Templates: Type-specific configuration templates
Participant Management: Track user status (started/passed/failed)
Answer Validation: Automatic grading for quiz quests
Completion Messages: Customizable success messages

Data Structure#

Endpoints#

MethodEndpointDescription
GET/questRetrieve all quest
POST/questCreate new quest
GET/quest/{id}Get specific quest
PUT/quest/{id}Update quest
DELETE/quest/{id}Delete quest
POST/quest/{id}/acceptUser starts quest
POST/quest/{id}/submit-answersSubmit quiz answers
GET/quest/{id}/answersRetrieve user's answers
GET/quest/{id}/participantsList all participants
Modified at 2025-04-14 09:35:18
Previous
Get collectibles
Next
Create quest
Built with