get group facet
/groups/{group}/facet [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9023 | 4.9505 | xml |
Description
Returns the facets for a specific field in the index.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| field | A valid index field | yes | string |
See Index for index fields available.
Permission
This service is restricted to guest and higher.
Response
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]"/> ... </facet>
If field is invalid, return:
<facet name="pd" type="field" computed="true" total="0"/>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x0201 | Missing required field |