searchContents( )


Retrieves a list of all translation content associated with a site that matches the search query, with optional data aggregation.

Note that this method allows you to retrieve all translation content for a site, regardless of which app created it.

Use this method to search translation content fields on a site for a given expression, and/or to perform data aggregations on a site's translation content fields.

To learn about working with Search methods, see API Query Language (SDK | REST) and Sorting and Paging (SDK | REST).

PropertyCapabilitiesFilters
_idSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
entityIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
localeSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
parentEntityIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
previewFieldSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
publishStatusSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
schemaIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
fields.richContentSearch:
Aggregate: ✗
Sort: ✗
fields.textValueSearch:
Aggregate: ✗
Sort: ✗
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Wix Multilingual - Translation Content + Published Content Read
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
searchCursorSearchRequired

Search criteria including filter, sort, aggregations, and paging options.

Returns
Return Type:Promise<SearchContentsResponse>
Errors

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

Did this help?