Redirects

Use case - Fetching redirect links

Request

Method: POST

Endpoint: /v1.4/search

curl --location 'https://SEARCH_DOMAIN_URL/v1.4/search' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer cGFTZXXXXXXXXXXXXXXXA==' \
    --data '{
        "customer_id": "076XXXXXXXXXfb6",
        "website_id": "c63XXXXXXXXXce",
        "q": "SEARCH STRING",
        "client": "CLIENT SHORTCODE",
        "start": 0,
        "size": 1
    }'

Response

{
  "type" : 1,
  "code" : 0,
  "payload": {
    "aggregations": {
     ***
    },
    "result": [
      ***
    ],
    "total_results": ***,
    "suggestions" : {***},
    "redirects" : {"url": "https://sample_url.com/", "label": "Sample"}
  }
}

Fields

Field	Subfield	Type	Usage
redirects	url	String	Returns a url to be redirected to configured using Web-App
redirects	label	String	Returns a name for the redirection configured using Web-App