> 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 # SearchRsvps # Package: registration # Namespace: RsvpManagement # Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/rsvp-v2/search-rsvps.md ## Permission Scopes: Read Event Tickets and Guest List: SCOPE.DC-EVENTS.READ-GUEST-LIST ## Introduction Retrieves a list of RSVPs that match the specified search query and optionally performs aggregations on the data queried. To learn about working with _search_, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/get-started/field-projection.md). --- ## REST API ### Schema ``` Method: searchRsvps Description: Retrieves a list of RSVPs that match the specified search query and optionally performs aggregations on the data queried. To learn about working with _search_, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/get-started/field-projection.md). URL: https://www.wixapis.com/events/v2/rsvps/search Method: POST Method parameters: param name: fields | type: array | description: Predefined sets of fields to return. - enum: - DETAILS: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. - FORM: Returns `form`. - CONTACT_DETAILS: Returns `email`. param name: search | type: CursorSearch - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Sort is in the ascending order. - DESC: Sort is in the descending order. - name: aggregations | type: array | description: Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. - ONE-OF: - name: includeOptions | type: IncludeMissingValuesOptions | description: Whether to include or exclude missing values in the aggregation results. Default: `EXCLUDE`. - name: addToBucket | type: string | description: Specify a custom name for the bucket containing the missing values. Defaults: `"N/A"` for strings, `0` for integers, and `false` for booleans. - name: sortType | type: SortType | description: Sort type. - enum: - COUNT: Number of matches in the results. - VALUE: Alphabetically by the field value. - name: sortDirection | type: SortDirection | description: Sort direction. - enum: - DESC: Descending order. - ASC: Ascending order. - name: limit | type: integer | description: Number of aggregation results to return. Min: `1` Max: `250` Default: `10` - name: missingValues | type: MissingValues | description: Whether to include or exclude missing values from the aggregation results.

Default: `EXCLUDE`. - enum: - EXCLUDE: Exclude missing values from the aggregation results. - INCLUDE: Include missing values in the aggregation results. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. - name: buckets | type: array | description: List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds. - name: from | type: number | description: Inclusive lower bound of the range. Required if `to` is not given. - name: to | type: number | description: Exclusive upper bound of the range. Required if `from` is not given. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: type | type: ScalarType | description: Operator type for the scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. - name: interval | type: Interval | description: Interval for date histogram aggregation - enum: YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND - name: nested | type: NestedAggregation | description: A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. - name: nestedAggregations | type: array | description: Flattened list of aggregations, where each aggregation is nested within previous one. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: name | type: string | description: Unique, caller-defined aggregation name, returned in `aggregations.results`. - name: type | type: NestedAggregationType | description: Type of aggregation to perform. The matching aggregation field must be passed. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: name | type: string | description: Aggregation name displayed in the return. - name: type | type: AggregationType | description: Type of aggregation to perform. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: search | type: SearchDetails | description: Free text to match in searchable fields. - name: mode | type: Mode | description: Search mode. Defines the search logic for combining multiple terms in the `expression`. - enum: - OR: At least one of the search terms must be present. - AND: Searches by all provided words. - name: expression | type: string | description: Search term or expression. - name: fields | type: array | description: Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, For example, `order.address.streetName`. - name: fuzzy | type: boolean | description: Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. - name: timeZone | type: string | description: Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone GUIDs) format. Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z". Return type: SearchRsvpsResponse - name: rsvps | type: array | description: Retrieved RSVPs. - name: id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: createdDate | type: string | description: Date and time the RSVP was created. - name: updatedDate | type: string | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: string | description: Date and time the guest checked in. - name: checkInCanceledDate | type: string | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. - name: aggregationData | type: AggregationData | description: Aggregation data. - name: results | type: array | description: List of the aggregated data results. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: results | type: array | description: List of ranges returned in the same order as requested. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Total number of entities with this value. - name: ranges | type: RangeResults | description: Range aggregation results. - name: results | type: array | description: List of ranges returned in same order as requested. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Count of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: type | type: ScalarType | description: Type of scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: value | type: number | description: Value of the scalar aggregation. - name: groupedByValue | type: GroupByValueResults | description: Group by value aggregation results. - name: results | type: array | description: List of value aggregations. - name: value | type: string | description: Value of the field. - name: nestedResults | type: NestedAggregationResults | description: Nested aggregations. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: ranges | type: RangeResults | description: Range aggregation results. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: name | type: string | description: Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`. - name: type | type: AggregationType | description: Aggregation type. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field which the data was aggregated by. - name: dateHistogram | type: DateHistogramResults | description: Date histogram aggregation results. - name: results | type: array | description: List of date histogram aggregations. - name: value | type: string | description: Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - name: count | type: integer | description: Total number of entities in the bucket. - name: nested | type: NestedResults | description: Nested aggregation results. - name: results | type: array | description: List of nested aggregations. - name: results | type: Map | description: List of nested aggregations. - ONE-OF: - name: value | type: ValueResult | description: Value aggregation result. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Total number of entities with this value. - name: range | type: RangeResult | description: Range aggregation result. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Total number of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation result. - name: value | type: number | description: Value of the scalar aggregation. - name: dateHistogram | type: ValueResult | description: Date histogram aggregation result. - name: name | type: string | description: Aggregation name displayed in the return. - name: type | type: AggregationType | description: Type of aggregation that was performed. - name: fieldPath | type: string | description: Field which the data was aggregated by. ``` ### Examples ### Search RSVPs ```curl curl -X POST 'https://www.wixapis.com/events-rsvps/v2/rsvps/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "search": { "sort": [ { "fieldName": "lastName", "order": "ASC" } ], "filter": { "status": "YES" }, "cursorPaging": { "limit": 1 } }, "fields": [ "DETAILS", "FORM" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.registration.RsvpManagement.searchRsvps(search, options) Description: Retrieves a list of RSVPs that match the specified search query and optionally performs aggregations on the data queried. To learn about working with _search_, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/get-started/field-projection.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: search Method parameters: param name: options | type: SearchRsvpsOptions none - name: fields | type: array | description: Predefined sets of fields to return. - enum: - DETAILS: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. - FORM: Returns `form`. - CONTACT_DETAILS: Returns `email`. param name: search | type: CursorSearch | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: - ASC: Sort is in the ascending order. - DESC: Sort is in the descending order. - name: aggregations | type: array | description: Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. - ONE-OF: - name: includeOptions | type: IncludeMissingValuesOptions | description: Whether to include or exclude missing values in the aggregation results. Default: `EXCLUDE`. - name: addToBucket | type: string | description: Specify a custom name for the bucket containing the missing values. Defaults: `"N/A"` for strings, `0` for integers, and `false` for booleans. - name: sortType | type: SortType | description: Sort type. - enum: - COUNT: Number of matches in the results. - VALUE: Alphabetically by the field value. - name: sortDirection | type: SortDirection | description: Sort direction. - enum: - DESC: Descending order. - ASC: Ascending order. - name: limit | type: integer | description: Number of aggregation results to return. Min: `1` Max: `250` Default: `10` - name: missingValues | type: MissingValues | description: Whether to include or exclude missing values from the aggregation results.

Default: `EXCLUDE`. - enum: - EXCLUDE: Exclude missing values from the aggregation results. - INCLUDE: Include missing values in the aggregation results. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. - name: buckets | type: array | description: List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds. - name: from | type: number | description: Inclusive lower bound of the range. Required if `to` is not given. - name: to | type: number | description: Exclusive upper bound of the range. Required if `from` is not given. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: type | type: ScalarType | description: Operator type for the scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. - name: interval | type: Interval | description: Interval for date histogram aggregation - enum: YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND - name: nested | type: NestedAggregation | description: A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. - name: nestedAggregations | type: array | description: Flattened list of aggregations, where each aggregation is nested within previous one. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: name | type: string | description: Unique, caller-defined aggregation name, returned in `aggregations.results`. - name: type | type: NestedAggregationType | description: Type of aggregation to perform. The matching aggregation field must be passed. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: name | type: string | description: Aggregation name displayed in the return. - name: type | type: AggregationType | description: Type of aggregation to perform. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: search | type: SearchDetails | description: Free text to match in searchable fields. - name: mode | type: Mode | description: Search mode. Defines the search logic for combining multiple terms in the `expression`. - enum: - OR: At least one of the search terms must be present. - AND: Searches by all provided words. - name: expression | type: string | description: Search term or expression. - name: fields | type: array | description: Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, For example, `order.address.streetName`. - name: fuzzy | type: boolean | description: Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. - name: timeZone | type: string | description: Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone GUIDs) format. Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z". Return type: PROMISE - name: rsvps | type: array | description: Retrieved RSVPs. - name: _id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: _createdDate | type: Date | description: Date and time the RSVP was created. - name: _updatedDate | type: Date | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: Date | description: Date and time the guest checked in. - name: checkInCanceledDate | type: Date | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. - name: aggregationData | type: AggregationData | description: Aggregation data. - name: results | type: array | description: List of the aggregated data results. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: results | type: array | description: List of ranges returned in the same order as requested. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Total number of entities with this value. - name: ranges | type: RangeResults | description: Range aggregation results. - name: results | type: array | description: List of ranges returned in same order as requested. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Count of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: type | type: ScalarType | description: Type of scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: value | type: number | description: Value of the scalar aggregation. - name: groupedByValue | type: GroupByValueResults | description: Group by value aggregation results. - name: results | type: array | description: List of value aggregations. - name: value | type: string | description: Value of the field. - name: nestedResults | type: NestedAggregationResults | description: Nested aggregations. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: ranges | type: RangeResults | description: Range aggregation results. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: name | type: string | description: Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`. - name: type | type: AggregationType | description: Aggregation type. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field which the data was aggregated by. - name: dateHistogram | type: DateHistogramResults | description: Date histogram aggregation results. - name: results | type: array | description: List of date histogram aggregations. - name: value | type: string | description: Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - name: count | type: integer | description: Total number of entities in the bucket. - name: nested | type: NestedResults | description: Nested aggregation results. - name: results | type: array | description: List of nested aggregations. - name: results | type: Map | description: List of nested aggregations. - ONE-OF: - name: value | type: ValueResult | description: Value aggregation result. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Total number of entities with this value. - name: range | type: RangeResult | description: Range aggregation result. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Total number of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation result. - name: value | type: number | description: Value of the scalar aggregation. - name: dateHistogram | type: ValueResult | description: Date histogram aggregation result. - name: name | type: string | description: Aggregation name displayed in the return. - name: type | type: AggregationType | description: Type of aggregation that was performed. - name: fieldPath | type: string | description: Field which the data was aggregated by. ``` ### Examples ### searchRsvps ```javascript import { rsvpV2 } from '@wix/events'; async function searchRsvps(search,options) { const response = await rsvpV2.searchRsvps(search,options); }; ``` ### searchRsvps (with elevated permissions) ```javascript import { rsvpV2 } from '@wix/events'; import { auth } from '@wix/essentials'; async function mySearchRsvpsMethod(search,options) { const elevatedSearchRsvps = auth.elevate(rsvpV2.searchRsvps); const response = await elevatedSearchRsvps(search,options); } ``` ### searchRsvps (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { rsvpV2 } from '@wix/events'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { rsvpV2 }, // Include the auth strategy and host as relevant }); async function searchRsvps(search,options) { const response = await myWixClient.rsvpV2.searchRsvps(search,options); }; ``` ---