List Quests by Publication URL | AISquare Studio

curl -X POST /api/v1/quests/by-url/ \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": 42,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Introduction to Machine Learning",
  "player_level": {
    "id": 3,
    "uid": "1c6e4f9a-8b2d-4f3a-9f7e-2a1b3c4d5e6f",
    "name": "Beginner",
    "description": "Suitable for learners with no prior experience",
    "avg_score": 75
  },
  "metrics": "Completion rate: 85%, Average score: 78",
  "created_by": {
    "id": 7,
    "username": "jatin_saini",
    "email": "jatin.saini@aisquare.com",
    "full_name": "Jatin Saini",
    "is_verified": true,
    "details": [
      {
        "profile_picture": "https://aisquare.com/profiles/jatin_saini.jpg",
        "bio": "AI enthusiast and educator with 10 years of experience.",
        "country": "India",
        "phone": "+91-9876543210",
        "linkedin_url": "https://linkedin.com/in/jatinsaini",
        "github_url": "https://github.com/jatinsaini",
        "twitter_url": "https://twitter.com/jatinsaini",
        "website_url": "https://jatinsaini.ai",
        "top_domain_elo": 1520.5,
        "top_domain_rank": 12
      }
    ],
    "followers_count": 1200
  },
  "created_at": "2024-01-15T09:30:00Z",
  "publication_url": "https://aisquare.com/publications/ai-learning",
  "publication": {},
  "user_added_quest": true,
  "updated_at": "2024-01-15T09:30:00Z",
  "workspace_id": 5,
  "urls": [
    "https://aisquare.com/quests/ml-intro"
  ],
  "files": [
    "https://aisquare.com/resources/ml-intro-guide.pdf"
  ],
  "logo": "https://aisquare.com/assets/logos/ml-logo.png",
  "cover": "https://aisquare.com/assets/covers/ml-cover.jpg",
  "tags": [
    null
  ],
  "category": "Technology",
  "subcategory": "Artificial Intelligence",
  "focus_area": "Machine Learning Fundamentals",
  "visibility": "public",
  "summary": "A beginner-friendly quest to understand the basics of machine learning.",
  "description": "This quest covers fundamental concepts of machine learning including supervised and unsupervised learning, common algorithms, and practical applications.",
  "co_creators": [
    null
  ],
  "creation_status": "not_started"
}

This endpoint returns a paginated list of quests. For GET requests, it returns the base quest list. For POST requests, if the JSON body contains a ‘url’ parameter (representing the publication’s custom URL), the view will filter the quests to return only those whose ‘created_by’ matches the Publication owner’s user. If the ‘url’ parameter is omitted, the full list is returned.

Request

This endpoint expects an object.

urlstringOptional

The custom URL of the publication used to filter the quests.

Response

A paginated list of quests. If a 'url' is provided in the POST body, only quests created by the corresponding Publication owner are returned.

idintegerRead-only

uidstringRead-onlyformat: "uuid"

namestring<=255 characters

player_levelobject

Minimal serializer for PlayerLevel to be used in other modules

metricsstringRead-only

created_byobject

created_atdatetimeRead-only

publication_urlstring or nullRead-only

Get the publication URL from the quest's source experience

publicationmap from strings to any or nullRead-only

Get the publication from the quest's source experience

user_added_questbooleanRead-only

Check if the current user has added this quest

updated_atdatetimeRead-only

workspace_idintegerRead-only

urlslist of strings

fileslist of strings or null

logostring or nullformat: "uri"

coverstring or nullformat: "uri"

tagslist of any

categorystring

subcategorystring

learningsany or null

quiz_formatany or null

focus_areastring or null<=256 characters

recommended_skillsany or null

List of recommended skills for this quest

visibilityenum

public - Public
private - Private
team - Team
org - Organization

* `public` - Public * `private` - Private * `team` - Team * `org` - Organization

Allowed values:

summarystring or null<=1024 characters

descriptionstring or null

co_creatorslist of any

creation_statusenum

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

* `not_started` - Not Started * `in_progress` - In Progress * `completed` - Completed * `failed` - Failed

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error