This module adds a new Views style plugin to add additional metadata into the response for REST Export displays in Views with the following:
- Result items
- Total results
- Total pages
- Items per page
- Items per page options
- Current page
- Typeahead path for autocompleting inputs
- Available exposed filters
- Available exposed sorts
- Available Facets (from the Facets module)
Additionally, you can toggle Facet inclusion on or off for a given display as well as 'rename' the keys in the response. The latter is useful for matching up with frontend implementations that may not match the default property names in Drupal (for instance "data" instead of "results"). The typeahead path can be provided by Search API Autocomplete or be a custom path in your implementation that returns results to the frontend.
This module is best suited for hybrid or decoupled interfaces that lets them access a Views REST display URL and received a JSON or XML response in return with all the information they would need to build a search interface in React, Vue, or similar. The plugin works for REST export displays only and has been used extensively in Search API / Search API Solr setups.
Using this approach will let you build several frontend components quickly while maintaining a consistent backend via Views and agree on the data contract between the frontend and backend or make quick adjustments from the View itself rather than in code.
Project information
- Project categories: Content editing experience, Developer tools
- Ecosystem: Search API
242 sites report using this module
- Created by kevinquillen on , updated
Stable releases for this project are covered by the security advisory policy.
Look for the shield icon below.


