Skip to main content

 Web service API

How to use PageSeeder's Web service API

get group facet

/groups/{group}/facet [GET]


Returns the facets for a specific field in the index.


NameDescriptionRequiredTypeDefault value
fieldA valid index fieldyesstring

See Index for index fields available.


This service is restricted to guest and higher.


When the field is valid, the XML returned is:

<facet name="[field name]" type="field" computed="true" total="[total]">
  <term field="[field name]" text="[term]" cardinality="[occurrences]"/>

If field is invalid, return:

<facet name="pd" type="field" computed="true" total="0"/>

Error Handling

CodeCause / Description
0x0201Missing required field
Created on , last edited on