Ordered data stores (beta)

This page includes reference documentation for working with ordered data stores. For more information on using the API, see Handle API requests for data stores and the usage guide.

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

List

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Returns a list of entries from an ordered data store.

Parameters

universeId string

The identifier of the experience with ordered data stores that you want to access. See Universe ID on how to copy it on Creator Dashboard.

Path
Required
orderedDataStore string

The name of the target ordered data store.

Path
Required
scope string

The name of the data store scope. See Scopes.

Path
Required
max_page_size number

The maximum number of entries to return. The service may return fewer than this value. The default value is 10. The maximum value is 100, and any input above 100 is coerced to 100.

page_token string

A page token received from a previous List call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to List must match the call providing the page token.

order_by string

The enumeration direction. The order by default is ascending. Input a desc suffix for descending.

filter string

The range of qualifying values of entries to return. See Filters.

Request

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \

 --header 'x-api-key: <insert-api-key>'

Response

200 - OK
OK
Returns an object
entries array<object>

The Entries from the specified Scope.

nextPageToken string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Required Permissions

The following API key permissions are required to call this endpoint. For more information on generating proper keys, see Manage API keys.

  • Read

Create

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Creates a new entry with the content value provided.

Parameters

universeId string

The identifier of the experience with ordered data stores that you want to access. See Universe ID on how to copy it on Creator Dashboard.

Path
Required
orderedDataStore string

The name of the ordered data store.

Path
Required
scope string

The name of the data store scope. See Scopes.

Path
Required
id string

The name of the entry.

Required

Request

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

Response

200 - OK
OK
Returns an object
path string

The resource path of the request.

id string

The name of the entry

value number

The value of the entry.

Required Permissions

The following API key permissions are required to call this endpoint. For more information on generating proper keys, see Manage API keys.

  • Write

Get

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Gets and returns the specified entry.

Parameters

universeId string

The identifier of the experience with ordered data stores that you want to access. See Universe ID on how to copy it on Creator Dashboard.

Path
Required
orderedDataStore string

The name of the ordered data store.

Path
Required
scope string

The name of the data store scope. See Scopes.

Path
Required
entry string

The entry ID.

Path
Required

Request

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

Response

200 - OK
OK
Returns an object
path string

The resource path of the request.

id string

The name of the entry

value number

The value of the entry.

Required Permissions

The following API key permissions are required to call this endpoint. For more information on generating proper keys, see Manage API keys.

  • Read

Delete

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Deletes the specified entry.

Parameters

universeId string

The identifier of the experience with ordered data stores that you want to access. See Universe ID on how to copy it on Creator Dashboard.

Path
Required
orderedDataStore string

The name of the ordered data store.

Path
Required
scope string

The name of the data store scope. See Scopes.

Path
Required
entry string

The entry ID.

Path
Required

Request

curl
curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

Response

Required Permissions

The following API key permissions are required to call this endpoint. For more information on generating proper keys, see Manage API keys.

  • Write

Update

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Updates an entry value and returns the updated entry.

Parameters

universeId string

The identifier of the experience with ordered data stores that you want to access. See Universe ID on how to copy it on Creator Dashboard.

Path
Required
orderedDataStore string

The name of the ordered data store.

Path
Required
scope string

The name of the data store scope. See Scopes.

Path
Required
entry string

The entry ID.

Path
Required
allow_missing boolean

The flag to allow the creation of an entry if the entry doesn't exist. See Allow missing flags.

Request

curl
curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

Response

200 - OK
OK
Returns an object
path string

The resource path of the request.

id string

The name of the entry

value number

The value of the entry.

Required Permissions

The following API key permissions are required to call this endpoint. For more information on generating proper keys, see Manage API keys.

  • Write

Increment

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

Increments the value of the key by the provided amount and returns the updated entry.

Known issue: Entry values can increment past the valid range and this may persist in the backend. Returned values will clamp to the valid range.

Parameters

universeId string

The identifier of the experience with ordered data stores that you want to access. See Universe ID on how to copy it on Creator Dashboard.

Path
Required
orderedDataStore string

The name of the ordered data store.

Path
Required
scope string

The name of the data store scope. See Scopes.

Path
Required
entry string

The entry ID.

Path
Required

Request

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "amount": <long> 

}'

Response

200 - OK
OK
Returns an object
path string

The resource path of the request.

id string

The name of the entry

value number

The value of the entry.

Required Permissions

The following API key permissions are required to call this endpoint. For more information on generating proper keys, see Manage API keys.

  • Write

Objects

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

Entry

Represents an entry.

Attributes

path string

The resource path of the request.

id string

The name of the entry

value number

The value of the entry.

IncrementEntryRequest

Increments entry value.

Attributes

amount number

The amount to increment by the entry value. If the input value exceeds the maximum value supported by int64, which is 9,223,372,036,854,775,807, the request fails with a 400 Bad Request error.

UpdateEntryRequest

Updates the entry provided with a new value.

Attributes

value number

The value to update the entry. If the input value exceeds the maximum value supported by int64, which is 9,223,372,036,854,775,807, the request fails with a 400 Bad Request error.

CreateEntryRequest

Creates a new entry with the value provided.

Attributes

value number

The value to set the new entry. If the input value exceeds the maximum value supported by int64, which is 9,223,372,036,854,775,807, the request fails with a 400 Bad Request error.

ListEntriesResponse

A list of Entries in the parent collection.

Attributes

entries array<object>

The Entries from the specified Scope.

nextPageToken string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.