RelatedQuery API

Overview

RelatedQuery API is an API for managing Fess related queries. You can suggest related search keywords for specific search queries.

Base URL

/api/admin/relatedquery

Endpoint List

Method	Path	Description
GET/PUT	/settings	List related queries
GET	/setting/{id}	Get related query
POST	/setting	Create related query
PUT	/setting	Update related query
DELETE	/setting/{id}	Delete related query

List Related Queries

Request

GET /api/admin/relatedquery/settings
PUT /api/admin/relatedquery/settings

Parameters

Parameter	Type	Required	Description
size	Integer	No	Number of items per page (default: 20)
page	Integer	No	Page number (starts from 0)

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "query_id_1",
        "term": "fess",
        "queries": ["fess tutorial", "fess installation", "fess configuration"]
      }
    ],
    "total": 5
  }
}

Get Related Query

Request

GET /api/admin/relatedquery/setting/{id}

Response

{
  "response": {
    "status": 0,
    "setting": {
      "id": "query_id_1",
      "term": "fess",
      "queries": ["fess tutorial", "fess installation", "fess configuration"],
      "virtualHost": ""
    }
  }
}

Create Related Query

Request

POST /api/admin/relatedquery/setting
Content-Type: application/json

Request Body

{
  "term": "search",
  "queries": ["search tutorial", "search syntax", "advanced search"],
  "virtualHost": ""
}

Field Description

Field	Required	Description
term	Yes	Search keyword
queries	Yes	Array of related queries
virtualHost	No	Virtual host

Response

{
  "response": {
    "status": 0,
    "id": "new_query_id",
    "created": true
  }
}

Update Related Query

Request

PUT /api/admin/relatedquery/setting
Content-Type: application/json

Request Body

{
  "id": "existing_query_id",
  "term": "search",
  "queries": ["search tutorial", "search syntax", "advanced search", "search tips"],
  "virtualHost": "",
  "versionNo": 1
}

Response

{
  "response": {
    "status": 0,
    "id": "existing_query_id",
    "created": false
  }
}

Delete Related Query

Request

DELETE /api/admin/relatedquery/setting/{id}

Response

{
  "response": {
    "status": 0,
    "id": "deleted_query_id",
    "created": false
  }
}

Usage Examples

Product Related Queries

curl -X POST "http://localhost:8080/api/admin/relatedquery/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "term": "product",
       "queries": ["product features", "product pricing", "product comparison", "product reviews"]
     }'

Help Related Queries

curl -X POST "http://localhost:8080/api/admin/relatedquery/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "term": "help",
       "queries": ["help center", "help documentation", "help contact support"]
     }'

Reference

• Admin API Overview - Admin API Overview

• RelatedContent API - Related Content API

• Suggest API - Suggest Management API

• Related Query - Related Query Management Guide