Skip to content

PlaylistPage

Martin Magyar edited this page Dec 22, 2023 · 2 revisions

Info

Can be returned by method:

For more detailed information see PlaylistPage model at BeatSaver API Docs. (bottom of the page)

Example response

{
    "maps": [
        {
            "map": {
                "automapper": true,
                "bookmarked": true,
                "collaborators": [
                    {
                        "admin": true,
                        "avatar": "string",
                        "curator": true,
                        "curatorTab": true,
                        "description": "string",
                        "email": "string",
                        "followData": {
                            "curation": true,
                            "followers": 0,
                            "following": true,
                            "follows": 0,
                            "upload": true
                        },
                        "hash": "string",
                        "id": 0,
                        "name": "string",
                        "patreon": "None",
                        "playlistUrl": "string",
                        "stats": {
                            "avgBpm": {},
                            "avgDuration": {},
                            "avgScore": {},
                            "diffStats": {
                                "easy": 0,
                                "expert": 0,
                                "expertPlus": 0,
                                "hard": 0,
                                "normal": 0,
                                "total": 0
                            },
                            "firstUpload": "2023-12-22T16:53:16.403Z",
                            "lastUpload": "2023-12-22T16:53:16.403Z",
                            "rankedMaps": 0,
                            "totalDownvotes": 0,
                            "totalMaps": 0,
                            "totalUpvotes": 0
                        },
                        "suspendedAt": "2023-12-22T16:53:16.403Z",
                        "testplay": true,
                        "type": "DISCORD",
                        "uniqueSet": true,
                        "uploadLimit": 0,
                        "verifiedMapper": true
                    }
                ],
                "createdAt": "2023-12-22T16:53:16.403Z",
                "curatedAt": "2023-12-22T16:53:16.403Z",
                "curator": {
                    "admin": true,
                    "avatar": "string",
                    "curator": true,
                    "curatorTab": true,
                    "description": "string",
                    "email": "string",
                    "followData": {
                        "curation": true,
                        "followers": 0,
                        "following": true,
                        "follows": 0,
                        "upload": true
                    },
                    "hash": "string",
                    "id": 0,
                    "name": "string",
                    "patreon": "None",
                    "playlistUrl": "string",
                    "stats": {
                        "avgBpm": {},
                        "avgDuration": {},
                        "avgScore": {},
                        "diffStats": {
                            "easy": 0,
                            "expert": 0,
                            "expertPlus": 0,
                            "hard": 0,
                            "normal": 0,
                            "total": 0
                        },
                        "firstUpload": "2023-12-22T16:53:16.403Z",
                        "lastUpload": "2023-12-22T16:53:16.403Z",
                        "rankedMaps": 0,
                        "totalDownvotes": 0,
                        "totalMaps": 0,
                        "totalUpvotes": 0
                    },
                    "suspendedAt": "2023-12-22T16:53:16.403Z",
                    "testplay": true,
                    "type": "DISCORD",
                    "uniqueSet": true,
                    "uploadLimit": 0,
                    "verifiedMapper": true
                },
                "declaredAi": "Admin",
                "deletedAt": "2023-12-22T16:53:16.403Z",
                "description": "string",
                "id": "string",
                "lastPublishedAt": "2023-12-22T16:53:16.403Z",
                "metadata": {
                    "bpm": {},
                    "duration": 0,
                    "levelAuthorName": "string",
                    "songAuthorName": "string",
                    "songName": "string",
                    "songSubName": "string"
                },
                "name": "string",
                "qualified": true,
                "ranked": true,
                "stats": {
                    "downloads": 0,
                    "downvotes": 0,
                    "plays": 0,
                    "reviews": 0,
                    "score": {},
                    "scoreOneDP": {},
                    "sentiment": "PENDING",
                    "upvotes": 0
                },
                "tags": ["None"],
                "updatedAt": "2023-12-22T16:53:16.403Z",
                "uploaded": "2023-12-22T16:53:16.403Z",
                "uploader": {
                    "admin": true,
                    "avatar": "string",
                    "curator": true,
                    "curatorTab": true,
                    "description": "string",
                    "email": "string",
                    "followData": {
                        "curation": true,
                        "followers": 0,
                        "following": true,
                        "follows": 0,
                        "upload": true
                    },
                    "hash": "string",
                    "id": 0,
                    "name": "string",
                    "patreon": "None",
                    "playlistUrl": "string",
                    "stats": {
                        "avgBpm": {},
                        "avgDuration": {},
                        "avgScore": {},
                        "diffStats": {
                            "easy": 0,
                            "expert": 0,
                            "expertPlus": 0,
                            "hard": 0,
                            "normal": 0,
                            "total": 0
                        },
                        "firstUpload": "2023-12-22T16:53:16.403Z",
                        "lastUpload": "2023-12-22T16:53:16.403Z",
                        "rankedMaps": 0,
                        "totalDownvotes": 0,
                        "totalMaps": 0,
                        "totalUpvotes": 0
                    },
                    "suspendedAt": "2023-12-22T16:53:16.403Z",
                    "testplay": true,
                    "type": "DISCORD",
                    "uniqueSet": true,
                    "uploadLimit": 0,
                    "verifiedMapper": true
                },
                "versions": [
                    {
                        "coverURL": "string",
                        "createdAt": "2023-12-22T16:53:16.403Z",
                        "diffs": [
                            {
                                "bombs": 0,
                                "characteristic": "Standard",
                                "chroma": true,
                                "cinema": true,
                                "difficulty": "Easy",
                                "events": 0,
                                "label": "string",
                                "length": 0,
                                "maxScore": 0,
                                "me": true,
                                "ne": true,
                                "njs": {},
                                "notes": 0,
                                "nps": 0,
                                "obstacles": 0,
                                "offset": {},
                                "paritySummary": {
                                    "errors": 0,
                                    "resets": 0,
                                    "warns": 0
                                },
                                "seconds": 0,
                                "stars": {}
                            }
                        ],
                        "downloadURL": "string",
                        "feedback": "string",
                        "hash": "string",
                        "key": "string",
                        "previewURL": "string",
                        "sageScore": {},
                        "scheduledAt": "2023-12-22T16:53:16.403Z",
                        "state": "Uploaded",
                        "testplayAt": "2023-12-22T16:53:16.403Z",
                        "testplays": [
                            {
                                "createdAt": "2023-12-22T16:53:16.403Z",
                                "feedback": "string",
                                "feedbackAt": "2023-12-22T16:53:16.403Z",
                                "user": {
                                    "admin": true,
                                    "avatar": "string",
                                    "curator": true,
                                    "curatorTab": true,
                                    "description": "string",
                                    "email": "string",
                                    "followData": {
                                        "curation": true,
                                        "followers": 0,
                                        "following": true,
                                        "follows": 0,
                                        "upload": true
                                    },
                                    "hash": "string",
                                    "id": 0,
                                    "name": "string",
                                    "patreon": "None",
                                    "playlistUrl": "string",
                                    "stats": {
                                        "avgBpm": {},
                                        "avgDuration": {},
                                        "avgScore": {},
                                        "diffStats": {
                                            "easy": 0,
                                            "expert": 0,
                                            "expertPlus": 0,
                                            "hard": 0,
                                            "normal": 0,
                                            "total": 0
                                        },
                                        "firstUpload": "2023-12-22T16:53:16.403Z",
                                        "lastUpload": "2023-12-22T16:53:16.403Z",
                                        "rankedMaps": 0,
                                        "totalDownvotes": 0,
                                        "totalMaps": 0,
                                        "totalUpvotes": 0
                                    },
                                    "suspendedAt": "2023-12-22T16:53:16.403Z",
                                    "testplay": true,
                                    "type": "DISCORD",
                                    "uniqueSet": true,
                                    "uploadLimit": 0,
                                    "verifiedMapper": true
                                },
                                "video": "string"
                            }
                        ]
                    }
                ]
            },
            "order": {}
        }
    ],
    "playlist": {
        "config": {},
        "createdAt": "2023-12-22T16:53:16.403Z",
        "curatedAt": "2023-12-22T16:53:16.403Z",
        "curator": {
            "admin": true,
            "avatar": "string",
            "curator": true,
            "curatorTab": true,
            "description": "string",
            "email": "string",
            "followData": {
                "curation": true,
                "followers": 0,
                "following": true,
                "follows": 0,
                "upload": true
            },
            "hash": "string",
            "id": 0,
            "name": "string",
            "patreon": "None",
            "playlistUrl": "string",
            "stats": {
                "avgBpm": {},
                "avgDuration": {},
                "avgScore": {},
                "diffStats": {
                    "easy": 0,
                    "expert": 0,
                    "expertPlus": 0,
                    "hard": 0,
                    "normal": 0,
                    "total": 0
                },
                "firstUpload": "2023-12-22T16:53:16.403Z",
                "lastUpload": "2023-12-22T16:53:16.403Z",
                "rankedMaps": 0,
                "totalDownvotes": 0,
                "totalMaps": 0,
                "totalUpvotes": 0
            },
            "suspendedAt": "2023-12-22T16:53:16.403Z",
            "testplay": true,
            "type": "DISCORD",
            "uniqueSet": true,
            "uploadLimit": 0,
            "verifiedMapper": true
        },
        "deletedAt": "2023-12-22T16:53:16.403Z",
        "description": "string",
        "downloadURL": "string",
        "name": "string",
        "owner": {
            "admin": true,
            "avatar": "string",
            "curator": true,
            "curatorTab": true,
            "description": "string",
            "email": "string",
            "followData": {
                "curation": true,
                "followers": 0,
                "following": true,
                "follows": 0,
                "upload": true
            },
            "hash": "string",
            "id": 0,
            "name": "string",
            "patreon": "None",
            "playlistUrl": "string",
            "stats": {
                "avgBpm": {},
                "avgDuration": {},
                "avgScore": {},
                "diffStats": {
                    "easy": 0,
                    "expert": 0,
                    "expertPlus": 0,
                    "hard": 0,
                    "normal": 0,
                    "total": 0
                },
                "firstUpload": "2023-12-22T16:53:16.404Z",
                "lastUpload": "2023-12-22T16:53:16.404Z",
                "rankedMaps": 0,
                "totalDownvotes": 0,
                "totalMaps": 0,
                "totalUpvotes": 0
            },
            "suspendedAt": "2023-12-22T16:53:16.404Z",
            "testplay": true,
            "type": "DISCORD",
            "uniqueSet": true,
            "uploadLimit": 0,
            "verifiedMapper": true
        },
        "playlistId": 0,
        "playlistImage": "string",
        "playlistImage512": "string",
        "songsChangedAt": "2023-12-22T16:53:16.404Z",
        "stats": {
            "avgScore": {},
            "downVotes": 0,
            "mapperCount": 0,
            "maxNps": 0,
            "maxNpsTwoDP": 0,
            "minNps": 0,
            "minNpsTwoDP": 0,
            "scoreOneDP": {},
            "totalDuration": 0,
            "totalMaps": 0,
            "upVotes": 0
        },
        "type": "Private",
        "updatedAt": "2023-12-22T16:53:16.404Z"
    }
}
Clone this wiki locally