> Portal Navigation:
>
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt
## Resource: Schemas for Wix Search
## Article: Schemas for Wix Search
## Article Link: https://dev.wix.com/docs/api-reference/business-management/site-search/wix-site-search/schemas-for-wix-search.md
## Article Content:
# Schemas for Wix Search
The [Search API](https://dev.wix.com/docs/api-reference/business-management/site-search/wix-site-search/search.md) supports several document types, each with its own schema that defines which fields support filtering, sorting, and search.
The sections below provide information about each supported document type's schema.
## BLOG_POSTS
The table below lists the fields available for the `BLOG_POSTS` document type:
::::tabs
:::REST_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ---------------- | ------------------------------------------------------------ | ----------------------- | ------------------------------------------------------------------------- |
| `documentType` | String | Document type that was searched. In this case, `BLOG_POSTS`. | | |
| `id` | String | The ID of the blog post. | | |
| `title` | String | The title of the blog post. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `startsWith`, `exists`, `nin` |
| `description` | String | Text of the blog post. | Searchable | |
| `url` | String | Relative URL of the blog post page on the site. | | |
| `image` | String | File source of the blog post's cover image. | | |
| `hashTags` | Array of Strings | List of hashtags in the blog post. | Searchable | `hasSome`, `hasAll` |
| `tags` | Array of Strings | List of tags in the blog post. | Searchable
Facetable | `hasSome`, `hasAll` |
| `tagIds` | Array of Strings | List of tag IDs in the blog post. | Facetable | `hasSome`, `hasAll` |
| `publishDate` | Date | Date and time the blog post was originally published. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `categories` | Array of Strings | Categories associated with the blog post. | | `hasSome`, `hasAll` |
| `author` | String | Author of the blog post. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
:::
:::SDK_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ---------------- | ------------------------------------------------------------ | ----------------------- | ------------------------------------------------------------------------- |
| `documentType` | String | Document type that was searched. In this case, `BLOG_POSTS`. | | |
| `_id` | String | The ID of the blog post. | | |
| `title` | String | The title of the blog post. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `startsWith`, `exists`, `nin` |
| `description` | String | Text of the blog post. | Searchable | |
| `url` | String | Relative URL of the blog post page on the site. | | |
| `image` | String | File source of the blog post's cover image. | | |
| `hashTags` | Array of Strings | List of hashtags in the blog post. | Searchable | `hasSome`, `hasAll` |
| `tags` | Array of Strings | List of tags in the blog post. | Searchable
Facetable | `hasSome`, `hasAll` |
| `tagIds` | Array of Strings | List of tag IDs in the blog post. | Facetable | `hasSome`, `hasAll` |
| `publishDate` | Date | Date and time the blog post was originally published. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `categories` | Array of Strings | Categories associated with the blog post. | | `hasSome`, `hasAll` |
| `author` | String | Author of the blog post. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
:::
::::
## BOOKING_SERVICES
The table below lists the fields available for the `BOOKING_SERVICES` document type:
::::tabs
:::REST_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ---------------- | ------------------------------------------------------------------ | ----------------------- | ------------------------------------------ |
| `documentType` | String | Document type that was searched. In this case, `BOOKING_SERVICES`. | | |
| `id` | String | Service ID. | | |
| `title` | String | Service name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Service description. | Searchable | |
| `url` | String | Service page's link. | | |
| `image` | String | File source of the image for this service. | | |
| `category` | String | Category associated with the service. | Searchable | |
| `tagLine` | String | Service's tagline (subtitle). | Searchable | |
| `staffMembers` | Array of Strings | Staff members associated with the service. | Searchable
Facetable | `hasSome`, `hasAll` |
| `benefits` | Array of Strings | Member benefits. | Searchable
Facetable | `hasSome`, `hasAll` |
:::
:::SDK_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ---------------- | ------------------------------------------------------------------ | ----------------------- | ------------------------------------------ |
| `documentType` | String | Document type that was searched. In this case, `BOOKING_SERVICES`. | | |
| `_id` | String | Service ID. | | |
| `title` | String | Service name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Service description. | Searchable | |
| `url` | String | Service page's link. | | |
| `image` | String | File source of the image for this service. | | |
| `category` | String | Category associated with the service. | Searchable | |
| `tagLine` | String | Service's tagline (subtitle). | Searchable | |
| `staffMembers` | Array of Strings | Staff members associated with the service. | Searchable
Facetable | `hasSome`, `hasAll` |
| `benefits` | Array of Strings | Member benefits. | Searchable
Facetable | `hasSome`, `hasAll` |
:::
::::
## EVENTS
The table below lists the fields available for the `EVENTS` document type:
::::tabs
:::REST_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ------------- | -------------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------ |
| `documentType` | String | Document type that was searched. In this case, `EVENTS`. | | |
| `id` | String | Event ID. | | |
| `title` | String | Event name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Event description. | Searchable | |
| `url` | String | Event page's link. | | |
| `image` | String | File source of the image for this event. | | |
| `category` | String | Category associated with the event. | Searchable | |
| `tagLine` | String | Event's tagline (subtitle). | Searchable | |
| `startDate` | Date and time | Event start date. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `location` | String | Event location. | Searchable
Facetable
Sortable | |
| `minPrice` | Double | Minimum event price. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `maxPrice` | Double | Maximum event price. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `currency` | String | Currency of the event price. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
| `eventType` | String | Event type. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
:::
:::SDK_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ------------- | -------------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------ |
| `documentType` | String | Document type that was searched. In this case, `EVENTS`. | | |
| `_id` | String | Event ID. | | |
| `title` | String | Event name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Event description. | Searchable | |
| `url` | String | Event page's link. | | |
| `image` | String | File source of the image for this event. | | |
| `category` | String | Category associated with the event. | Searchable | |
| `tagLine` | String | Event's tagline (subtitle). | Searchable | |
| `startDate` | Date and time | Event start date. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `location` | String | Event location. | Searchable
Facetable
Sortable | |
| `minPrice` | Double | Minimum event price. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `maxPrice` | Double | Maximum event price. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `currency` | String | Currency of the event price. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
| `eventType` | String | Event type. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
:::
::::
## FORUM_CONTENT
The table below lists the fields available for the `FORUM_CONTENT` document type:
::::tabs
:::REST_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------------------- |
| `documentType` | String | Document type that was searched. In this case, `FORUM_CONTENT`. | | |
| `id` | String | Post or comment ID. | | |
| `title` | String | Post title. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Text of the post or comment. | Searchable | |
| `url` | String | Relative URL of the post page on the site. For comments, the URL points to the location of the comment on your post page. | | |
| `image` | String | File source of the post image. | | |
| `contentType` | String | Indicates whether the document is a post or a comment. Value can be "POST" or "COMMENT". | Facetable | `eq`, `ne` |
| `postId` | String | ID of the post the comment is associated with. Only relevant for comments. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
| `ownerId` | String | Unique ID of the site visitor who posted the post or comment. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
| `categoryId` | String | ID of the category associated with the post. | Facetable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
| `hashTags` | Array of Strings | Hashtags in the post. | Facetable | `hasSome`, `hasAll` |
| `lastActivityDate` | Date | Date and time of the last action performed on the post or comment. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `likeCount` | Number | Number of likes the post or comment received. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `viewCount` | Number | Number of views the post received. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `totalComments` | Number | Number of comments the post received. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `postTitle` | String | Title of the post. Only relevant for posts. | Searchable | |
| `categoryTitle` | String | Title of the category. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `parentId` | String | ID of the parent comment. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `createdDate` | Date | Date and time the comment or post was created. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `upvoteCount` | Number | Number of upvotes on the comment. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `downvoteCount` | Number | Number of downvotes on the comment. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `score` | Number | Number of upvotes minus the number of downvotes. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `editedDate` | Date | Date and time the comment or post was last edited. | Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `mentions` | Array of Strings | Users mentioned in the post. | | |
| `markedComments` | Array of Strings | IDs of the marked comments for the post (selected by forum admin or site owner). | | |
| `marked` | Boolean | Whether the comment is marked. | Sortable | `eq`, `ne` |
| `commentInteraction` | String | Defines what interaction may be applied on the comment. | | |
| `images` | Nested | Images from the post content. | | |
| `images.id` | String | WixMedia image ID, nested under `images`. | | |
| `images.url` | String | URL of the image, nested under `images`. | | |
| `images.height` | Number | Original height of the image, nested under `images`. | | |
| `images.width` | Number | Original width of the image, nested under `images`. | | |
| `reactionsCount` | Number | Number of reactions. | Facetable
Sortable | `hasSome`, `hasAll`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `postType` | String | Type of post. | Sortable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
:::
:::SDK_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------------------- |
| `documentType` | String | Document type that was searched. In this case, `FORUM_CONTENT`. | | |
| `_id` | String | Post or comment ID. | | |
| `title` | String | Post title. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Text of the post or comment. | Searchable | |
| `url` | String | Relative URL of the post page on the site. For comments, the URL points to the location of the comment on your post page. | | |
| `image` | String | File source of the post image. | | |
| `contentType` | String | Indicates whether the document is a post or a comment. Value can be "POST" or "COMMENT". | Facetable | `eq`, `ne` |
| `postId` | String | ID of the post the comment is associated with. Only relevant for comments. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
| `ownerId` | String | Unique ID of the site visitor who posted the post or comment. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
| `categoryId` | String | ID of the category associated with the post. | Facetable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
| `hashTags` | Array of Strings | Hashtags in the post. | Facetable | `hasSome`, `hasAll` |
| `lastActivityDate` | Date | Date and time of the last action performed on the post or comment. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `likeCount` | Number | Number of likes the post or comment received. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `viewCount` | Number | Number of views the post received. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `totalComments` | Number | Number of comments the post received. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `postTitle` | String | Title of the post. Only relevant for posts. | Searchable | |
| `categoryTitle` | String | Title of the category. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `parentId` | String | ID of the parent comment. | Facetable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `createdDate` | Date | Date and time the comment or post was created. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `upvoteCount` | Number | Number of upvotes on the comment. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `downvoteCount` | Number | Number of downvotes on the comment. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `score` | Number | Number of upvotes minus the number of downvotes. | Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `editedDate` | Date | Date and time the comment or post was last edited. | Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `mentions` | Array of Strings | Users mentioned in the post. | | |
| `markedComments` | Array of Strings | IDs of the marked comments for the post (selected by forum admin or site owner). | | |
| `marked` | Boolean | Whether the comment is marked. | Sortable | `eq`, `ne` |
| `commentInteraction` | String | Defines what interaction may be applied on the comment. | | |
| `images` | Nested | Images from the post content. | | |
| `images.id` | String | WixMedia image ID, nested under `images`. | | |
| `images.url` | String | URL of the image, nested under `images`. | | |
| `images.height` | Number | Original height of the image, nested under `images`. | | |
| `images.width` | Number | Original width of the image, nested under `images`. | | |
| `reactionsCount` | Number | Number of reactions. | Facetable
Sortable | `hasSome`, `hasAll`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `postType` | String | Type of post. | Sortable | `in`, `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
:::
::::
## PROGALLERY_ITEM
The table below lists the fields available for the `PROGALLERY_ITEM` document type:
::::tabs
:::REST_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ------- | ----------------------------------------------------------------- | ------------ | ------------------------------------------ |
| `documentType` | String | Document type that was searched. In this case, `PROGALLERY_ITEM`. | | |
| `id` | String | Pro Gallery item ID. | | |
| `title` | String | Pro Gallery item name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Pro Gallery item description. | Searchable | |
| `isVideo` | Boolean | Whether the gallery item is a video. | | `eq`, `ne`, `exists` |
:::
:::SDK_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| -------------- | ------- | ----------------------------------------------------------------- | ------------ | ------------------------------------------ |
| `documentType` | String | Document type that was searched. In this case, `PROGALLERY_ITEM`. | | |
| `_id` | String | Pro Gallery item ID. | | |
| `title` | String | Pro Gallery item name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Pro Gallery item description. | Searchable | |
| `isVideo` | Boolean | Whether the gallery item is a video. | | `eq`, `ne`, `exists` |
:::
::::
## STORES_PRODUCTS
The table below lists the fields available for the `STORES_PRODUCTS` document type:
::::tabs
:::REST_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| ------------------------ | ---------------- | ---------------------------------------------------------------------- | ----------------------- | ------------------------------------------------------------------------- |
| `documentType` | String | Document type that was searched. In this case, `STORES_PRODUCTS`. | | |
| `id` | String | Product ID. | | |
| `title` | String | Product name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Product description. | Searchable | |
| `url` | String | Relative URL of the product's page on the site. | | |
| `image` | String | File source of the main media image for this product. | | |
| `sku` | String | Product's stock keeping unit number. | Searchable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `inStock` | Boolean | Indicates whether the product is in stock. | Facetable
Sortable | `eq`, `ne` |
| `collections` | Array of Strings | Collections the product belongs to. | Searchable
Facetable | `hasSome`, `hasAll` |
| `onSale` | Boolean | Indicates whether the product is on sale. | Searchable
Sortable | `eq`, `ne` |
| `discountedPrice` | String | Price after a discount has been applied. | Sortable | `in`, `nin`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
| `discountedPriceNumeric` | Double | Numeric representation of the price after a discount has been applied. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `currency` | String | Currency of the store product's price. | Sortable | `in`, `nin`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
| `infoSections` | Array of Strings | Additional information sections for a product. | Searchable | `in`, `nin`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
:::
:::SDK_TAB
| Field | Type | Description | Capabilities | Supported Filters |
| ------------------------ | ---------------- | ---------------------------------------------------------------------- | ----------------------- | ------------------------------------------------------------------------- |
| `documentType` | String | Document type that was searched. In this case, `STORES_PRODUCTS`. | | |
| `_id` | String | Product ID. | | |
| `title` | String | Product name. | Searchable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `description` | String | Product description. | Searchable | |
| `url` | String | Relative URL of the product's page on the site. | | |
| `image` | String | File source of the main media image for this product. | | |
| `sku` | String | Product's stock keeping unit number. | Searchable
Sortable | `in`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte` |
| `inStock` | Boolean | Indicates whether the product is in stock. | Facetable
Sortable | `eq`, `ne` |
| `collections` | Array of Strings | Collections the product belongs to. | Searchable
Facetable | `hasSome`, `hasAll` |
| `onSale` | Boolean | Indicates whether the product is on sale. | Searchable
Sortable | `eq`, `ne` |
| `discountedPrice` | String | Price after a discount has been applied. | Sortable | `in`, `nin`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
| `discountedPriceNumeric` | Double | Numeric representation of the price after a discount has been applied. | Facetable
Sortable | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists` |
| `currency` | String | Currency of the store product's price. | Sortable | `in`, `nin`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
| `infoSections` | Array of Strings | Additional information sections for a product. | Searchable | `in`, `nin`, `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `exists`, `startsWith` |
:::
::::