Skip to main content

Suggestion

Request

Method: POST

Endpoint: /suggestion

curl --location 'https://SEARCH_DOMAIN_URL/v1.4/search' \
--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

FieldTypeRequiredDefaultDescription
customer_idStringYesRandom unique customer id generate by PA tracker
website_idStringYesClient unique website id provided by PA
qStringYesInput search query string
clientStringYesUnique client shortcode provided by PA

Response

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