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

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Read Data Items
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryDistinctValuesOptions

Options for querying distinct values.

Returns
Return Type:Promise<QueryDistinctValuesResponse>
Was this helpful?
Yes
No