Suggestion

Request

Method: POST

Endpoint: /suggestion

curl --location 'https://<PA_SEARCH_END_POINT>/suggestion' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer cGFTZXXXXXXXXXXXXXXXA==' \
--data '{
    "customer_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "website_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "q": "SEARCH STRING",
    "client": "CLIENT SHORTCODE"
}

Fields

Field	Type	Required	Default	Description
customer_id	String	No (Required only if Personalization is enabled)		Unique identifier for the customer, obtained from the Config API. This identifier persists throughout the customer's lifetime on the platform. For details on retrieving a customer ID, please refer to the Config API documentation.
website_id	String	Yes		Client unique website id provided by PA
q	String	Yes		Input search query string
client	String	Yes		Unique client shortcode provided by PA

Response

{
  "payload": {
    "suggested_terms": [
      {}
    ],
    "synthetic_suggested_terms": [
      {}
    ],
    "synthetic_trending_terms": [
      {}
    ],
    "trending_terms": [
      {}
    ]
  },
  "type": 1
}