searchExperiences( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Use this method to search the fields of the experiences on a site for a given expression.

You can also use this method to perform data aggregations on a site's experience fields.

Property	Capabilities	Filters
`configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startTime`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`configuration.onlineReservations.businessSchedule.entries.recurrence`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDaysAndTimes.day`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDaysAndTimes.time`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`tags.privateTags.tagIds`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`tags.publicTags.tagIds`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`_id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`reservationLocationId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`_createdDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`_updatedDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`configuration.displayInfo.name`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`configuration.onlineReservations.approval.mode`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`configuration.onlineReservations.businessSchedule.durationInMinutes`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`configuration.onlineReservations.maxGuests.number`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`configuration.onlineReservations.partySize.max`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`configuration.onlineReservations.partySize.min`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`configuration.paymentPolicy.paymentPolicyType`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`configuration.visible`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`configuration.displayInfo.richContent`	Search: ✓ Aggregate: ✗ Sort: ✗
`configuration.displayInfo.shortDescription`	Search: ✓ Aggregate: ✗ Sort: ✗

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

searchCursorSearchRequired

Search query.

Returns

Return Type:Promise<SearchExperiencesResponse>

Errors

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

Did this help?