Guide

ElasticPress REST API

Custom REST route that returns ElasticPress facet settings for the editor / Interactivity bootstrap.

Base path: /wp-json/prc-api/v3/

Source: includes/class-rest-api.php

Auth summary

AccessRoute
Public (permission_callback __return_true)GET /facets/get-settings

GET /facets/get-settings

Returns ElasticPress_Middleware::get_facets_settings().

Reference

Query parameters

Typed options, defaults, and constraints in one scannable reference.
1 field
templateSlug string required
Site Editor template slug used to decide which facets middleware should be enabled.
Request GET /wp-json/prc-api/v3/facets/get-settings?templateSlug=archive
HeadersKey: value
Accept application/json
Response 200 OK
BodyJSON
{
  "/*": "Facet settings object from ElasticPress_Middleware::get_facets_settings()"
}

Was this helpful?