About the Data Items API

Important: Starting from version 1.0.185, the Data Items API was significantly revised to closely match the functionality and syntax of the Velo wix-data API. If you are using an earlier version of this API, updating to the new version requires changes to your code. For previous versions, refer to the documentation for the deprecated API.

Note for app developers: Wix Data APIs require the site's code editor to be enabled. If you are building a Wix app, add a data collections extension to automatically enable the code editor and create data collections when your app is installed on a site.

The Data Items API allows you to access and manage items in a Wix site's data collections.

With the Data Items API, you can:

Create and manage data items in a site's collections.
Retrieve data items from a collection individually or with filtering and sorting queries.
Create and manage reference fields.
Perform aggregations and calculations on data in collections.
Truncate a data collection, removing all its contents.

The Data Items API only works with existing collections. To create and manage data collections, use the Data Collections API.

Before you begin

It's important to note the following points before starting to code:

The maximum size of an item you can save to a collection is 500 kb.
We don't recommend updating a data item more than once per second.
When using data retrieval methods such as query() or get() following an update to a collection's data, the data retrieved may not yet contain the most recent changes. See Wix Data and Eventual Consistency for more information and instructions for overriding this.
To speed up data retrieval, the results of certain data queries are cached. Learn more about caching data query results.
When your site makes a data request, it may take some time to receive a response. Wix Data places limits on how long a response can take before the request times out. If the response time exceeds this limit, Wix Data returns an error instead of the intended result.
When querying Wix app collections, check which fields can be filtered in the relevant collection field article.
Updating a data item replaces the existing item entirely. If the existing item had fields with values and those fields aren't included in the updated item, the values in those properties are lost.
Aggregations can't be performed on Wix app collections.
After connecting external database collections to a Wix site using the External Database Connections API, you can use the Data Items API to manage and retrieve data from those collections as if they were Wix Data collections.

Did this help?