List Quests by Publication URL | AISquare Studio

import requests
url = "https://api.example.com/api/v1/quests/by-url/"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "count": 123,
  "results": [
    {
      "id": 101,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Introduction to Data Science",
      "player_level": {
        "id": 3,
        "uid": "7b9e2f4a-8c3d-4f1a-9a2b-1d2e3f4a5b6c",
        "name": "Beginner",
        "description": "Suitable for users new to the topic",
        "avg_score": 75
      },
      "metrics": "completion_rate: 65%, average_time: 4h",
      "created_by": {
        "id": 100,
        "username": "john_smith",
        "email": "john.smith@aisquare.com",
        "full_name": "John Smith",
        "is_verified": true,
        "details": [
          {
            "profile_picture": "https://aisquare.com/profiles/john_smith.jpg",
            "bio": "Lead Content Creator",
            "country": "Canada",
            "phone": "+1-555-987-6543",
            "linkedin_url": "https://linkedin.com/in/johnsmith",
            "github_url": "https://github.com/johnsmith",
            "twitter_url": "https://twitter.com/johnsmith",
            "website_url": "https://johnsmith.dev",
            "top_domain_elo": 1800.75,
            "top_domain_rank": 15
          }
        ],
        "followers_count": 500
      },
      "created_at": "2024-01-15T09:30:00Z",
      "publication_url": "https://publication.aisquare.com/data-science",
      "publication": {
        "id": 10,
        "name": "AISquare Data Science Publication",
        "url": "https://publication.aisquare.com/data-science"
      },
      "user_added_quest": true,
      "updated_at": "2024-04-10T12:00:00Z",
      "workspace_id": 5,
      "urls": [
        "https://aisquare.com/quests/data-science-intro"
      ],
      "files": [
        "https://aisquare.com/resources/quests/data-science-intro/guide.pdf"
      ],
      "logo": "https://aisquare.com/assets/logos/data-science.png",
      "cover": "https://aisquare.com/assets/covers/data-science-cover.jpg",
      "tags": [
        "data",
        "science",
        "beginner"
      ],
      "category": "Technology",
      "subcategory": "Data Science",
      "focus_area": "Data Analysis and Visualization",
      "visibility": "public",
      "summary": "A beginner-friendly quest to learn the basics of data science.",
      "description": "This quest covers fundamental concepts in data science including data manipulation, visualization, and basic machine learning.",
      "co_creators": [
        {
          "id": 202,
          "username": "jane_doe",
          "email": "jane.doe@aisquare.com",
          "full_name": "Jane Doe",
          "is_verified": true,
          "details": [
            {
              "profile_picture": "https://aisquare.com/profiles/jane_doe.jpg",
              "bio": "Data Scientist and Educator",
              "country": "USA",
              "phone": "+1-555-123-4567",
              "linkedin_url": "https://linkedin.com/in/janedoe",
              "github_url": "https://github.com/janedoe",
              "twitter_url": "https://twitter.com/janedoe",
              "website_url": "https://janedoe.com",
              "top_domain_elo": 1500.5,
              "top_domain_rank": 42
            }
          ],
          "followers_count": 350
        }
      ],
      "creation_status": "in_progress"
    }
  ],
  "next": "http://api.aisquare.com/api/v1/quests/by-url/?page=4",
  "previous": "http://api.aisquare.com/api/v1/quests/by-url/?page=2"
}

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.

Query parameters

categorystringOptional

creation_statusenumOptional

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:

orderinglist of enumsOptional

Ordering

created_at - Created at
-created_at - Created at (descending)
name - Name
-name - Name (descending)
popularity - Popularity
-popularity - Popularity (descending)

Ordering * `created_at` - Created at * `-created_at` - Created at (descending) * `name` - Name * `-name` - Name (descending) * `popularity` - Popularity * `-popularity` - Popularity (descending)

ownedbooleanOptional

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

player_levelstringOptional

savedbooleanOptional

searchstringOptional

subcategorystringOptional

tagslist of integersOptional

visibilityenumOptional

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

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

Allowed values:

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.

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

Errors

400

Bad Request Error

401

Unauthorized Error