About the Wix Data API

 

 

The Wix Data API provides a complete solution for accessing, organizing, configuring, and managing data stored in a Wix site's database.

With the Wix Data API, you can:

• Create, modify, and delete data collections.
• Create indexes for data collections, to speed up data queries.
• Connect external databases to a Wix site.

Before you begin

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

• A Wix site's database can hold up to 1000 data collections.
• The maximum size of an item you can save to a collection is 500 kb.
• When naming fields in data collections, we recommend avoiding special characters. You can do this by using field names that match this regex pattern: [a-zA-Z_][a-zA-Z0-9_-]{0,63}.
• Each data collection defines a schema of fields for the items it contains. However, this schema isn't enforced. This means that if you add or update an item containing a field or data type that doesn't match the collection's schema specification, your data is stored anyway.
• When using data retrieval functions 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.
• After connecting external database collections to a Wix site using the External Database Connections API, you can use wix-data to manage and retrieve data from those collections as if they were Wix Data collections.

Request timeouts

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.

Request timeouts vary depending on your Wix plan and the type of collection you are attempting to access:

Collection Type	Wix plan	Timeout
CMS collections	Free sites, premium sites (excl. Elite and Business Elites)	5 seconds
CMS collections	Business Elite & Elite Premium	10 seconds
External Database Collections	All plans	15 seconds

After the specified timeout, the request fails and the following error message is displayed in your site logs:

WDE0028: Operation time limit exceeded.

Learn more about Wix Data error codes.

Terminology

• Data collection: A schema determining the structure of data items to be stored, defining the fields each item should contain and the data type of each field.
• Data item: A single data entry in a collection, in JSON format.
• Index: A map of a collection's data, organized according to selected fields. An index is used to increase query speed, and in some cases, to enforce unique values.
• External database connection: An adaptor that translates Wix data requests from a Wix site into an external database's protocol, and translates the response back into a format that Wix APIs can read. This enables Wix APIs, projects, and sites to treat the external database exactly as if it was an internal data collection.