Skip to content

SearchResponse

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

Info

Can be returned by methods:

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

Example response

{
    "docs": [
        {
            "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-22T14:44:24.337Z",
                        "lastUpload": "2023-12-22T14:44:24.337Z",
                        "rankedMaps": 0,
                        "totalDownvotes": 0,
                        "totalMaps": 0,
                        "totalUpvotes": 0
                    },
                    "suspendedAt": "2023-12-22T14:44:24.337Z",
                    "testplay": true,
                    "type": "DISCORD",
                    "uniqueSet": true,
                    "uploadLimit": 0,
                    "verifiedMapper": true
                }
            ],
            "createdAt": "2023-12-22T14:44:24.337Z",
            "curatedAt": "2023-12-22T14:44:24.337Z",
            "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-22T14:44:24.337Z",
                    "lastUpload": "2023-12-22T14:44:24.337Z",
                    "rankedMaps": 0,
                    "totalDownvotes": 0,
                    "totalMaps": 0,
                    "totalUpvotes": 0
                },
                "suspendedAt": "2023-12-22T14:44:24.337Z",
                "testplay": true,
                "type": "DISCORD",
                "uniqueSet": true,
                "uploadLimit": 0,
                "verifiedMapper": true
            },
            "declaredAi": "Admin",
            "deletedAt": "2023-12-22T14:44:24.337Z",
            "description": "string",
            "id": "string",
            "lastPublishedAt": "2023-12-22T14:44:24.337Z",
            "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-22T14:44:24.337Z",
            "uploaded": "2023-12-22T14:44:24.337Z",
            "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-22T14:44:24.337Z",
                    "lastUpload": "2023-12-22T14:44:24.337Z",
                    "rankedMaps": 0,
                    "totalDownvotes": 0,
                    "totalMaps": 0,
                    "totalUpvotes": 0
                },
                "suspendedAt": "2023-12-22T14:44:24.337Z",
                "testplay": true,
                "type": "DISCORD",
                "uniqueSet": true,
                "uploadLimit": 0,
                "verifiedMapper": true
            },
            "versions": [
                {
                    "coverURL": "string",
                    "createdAt": "2023-12-22T14:44:24.337Z",
                    "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-22T14:44:24.337Z",
                    "state": "Uploaded",
                    "testplayAt": "2023-12-22T14:44:24.337Z",
                    "testplays": [
                        {
                            "createdAt": "2023-12-22T14:44:24.337Z",
                            "feedback": "string",
                            "feedbackAt": "2023-12-22T14:44:24.337Z",
                            "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-22T14:44:24.337Z",
                                    "lastUpload": "2023-12-22T14:44:24.337Z",
                                    "rankedMaps": 0,
                                    "totalDownvotes": 0,
                                    "totalMaps": 0,
                                    "totalUpvotes": 0
                                },
                                "suspendedAt": "2023-12-22T14:44:24.337Z",
                                "testplay": true,
                                "type": "DISCORD",
                                "uniqueSet": true,
                                "uploadLimit": 0,
                                "verifiedMapper": true
                            },
                            "video": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "redirect": "string"
}
Clone this wiki locally