queryDistinctValues( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of distinct values for a given field in all items that match a query, without duplicates.

As with queryDataItems(), this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide. However, queryDistinctValues() doesn't return all of the full items that match the query. Rather, it returns all unique values of the field you specify in options.fieldName for items that match the query. If more than one item has the same value for that field, that value appears only once.

For more details on using queries, see API Query Language.

Note: When calling queryDistinctValues() following an update to your collection, the data retrieved may not reflect the most recent changes. If you need the most up-to-date data, set options.consistentRead to true.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage All Data Resources
Manage Data Items
Read Data Items
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryDistinctValuesOptions

Options for querying distinct values.

Returns
Return Type:Promise<QueryDistinctValuesResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?