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.

For field support for filters, sorting, and free-text searching see Translation Content: Supported Filters, Sorting, and Search.

To learn more about working with the search query, see API Query Language and Sorting and Paging.

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
Wix Multilingual - Translation Content + Published Content Read
Wix Multilingual
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsSearchContentsOptions
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?