Studio GuideWorld SDK Guide
Log In

Scan Player Data of World

Scan Key-Value of player in world by key

You can look up player data based on the search conditions you entered.
You can use this feature only in the World you created.
If you enter another person's World ID, Error 403 will be printed and state that you do not have permission.

Request

NameDescriptionType
worldIdWorld IDString
keyKey of dataString
startDateTimeStart date for data filtering
- UTC timezone
- yyyy-MM-ddTHH:mm:ss.SSSZ
- example: 2023-05-10T10:22:55.000Z
DateTime
endDateTimeEnd date for date filtering
- UTC timezone
- yyyy-MM-ddTHH:mm:ss.SSSZ
- example: 2023-05-10T10:22:55.000Z
DateTime
sizeScan size
- default: 20
- max: 1000
Number
nextIdNext scan ID
- Can be obtained from scan result
String
sortFieldField to sort and filter
- created or updated
String

Response

NameDescriptionType
dataList of dataArray
playerIdPlayer IDString
keyKey of dataString
valueValue of dataObject
createdDate created
- UTC timezone
- yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
DateTime
updatedDate updated
- UTC timezone
- yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
DateTime
nextIdNext scan IDString
hasNextExistence of next dataBoolean
Language
Authorization
Header
Click Try It! to start a request and see the response here!