POST

Search


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 site documents that match the provided search query and optionally performs aggregations on the data queried.

The Search API supports the document types listed in the Introduction, each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.

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

Permissions
Read Site Documents
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/_api/site-search/v1/search

Body Params
searchSearchRequired

Search query and aggregation information.


documentTypestringRequired

Document type to search in.


languagestringformat LANGUAGE

Language to search in.

Response Object
siteDocumentItemsArray <SiteDocument>

Documents matching the search query.


aggregationDataAggregationData

Aggregated data.


pagingOffsetMetadataPagingOffsetMetadata

Paging metadata.

Request
cURL
Response
JSON
Errors

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

Did this help?