group search facets
/groups/{group}/search/facets [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9400 |
Description
Get search facets for a single group.
This service does the same as the group search but only the facets for the search are returned.
For details see Service: /groups/{group}/search [GET].
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| facets | A comma-separated list of fields to use as facets | no | strings | |
| facetsize | The max number of facet values to load (ignored if larger than global property maxFacetSize - default 100) | no | integer | 10 |
| filters | A comma-separated list of field:term pairs to use as filters | no | strings | |
| flexiblefacets | A comma-separated list of fields to use as flexible facets | no | strings | |
| question | The question to search for | no | string | |
| questionfields | A comma-separated list of fields to search the question in | no | strings | pstitle,pscontent |
| ranges | A comma-separated list of range searches | no | strings |
Permission
This service is restricted to guest and higher unless the group is accessible to public.
Response
The XML response is:
<facets indexes="[comma separated group IDs]" [warning=""]> ... </facets>
For details see Service: /groups/{group}/search [GET].
Error Handling
| 0x1501 | If there is an invalid group specified |
|---|---|
| 0x1505 | If the facet size specified is bigger than the global property for face size ( maxFacetSize) |
| 0x1506 | If a numeric field is specified as a facet |