Create a query rewrite

import requests

url = "https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites"

payload = { "type": "HEAD_TAIL" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.post("https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"HEAD_TAIL\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'HEAD_TAIL'})
};

fetch('https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"HEAD_TAIL\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites"

	payload := strings.NewReader("{\n  \"type\": \"HEAD_TAIL\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'HEAD_TAIL'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request POST \
  --url https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "HEAD_TAIL"
}
'

{
  "type": "HEAD_TAIL",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "<string>",
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedBy": "<string>",
  "lastModified": "2023-11-07T05:31:56Z",
  "published": true,
  "version": "2023-11-07T05:31:56Z",
  "stagingFusionSyncStatus": {
    "lastSyncedVersion": "2023-11-07T05:31:56Z",
    "fusionVersion": "<string>"
  },
  "liveFusionSyncStatus": {
    "lastSyncedVersion": "2023-11-07T05:31:56Z",
    "fusionVersion": "<string>"
  },
  "markedForDeletion": true,
  "description": "<string>",
  "externalId": "<string>",
  "migratedId": "<string>",
  "surfaceForm": "<string>",
  "outputs": [
    "<string>"
  ]
}

POST

query-rewrites

Create a query rewrite

import requests

url = "https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites"

payload = { "type": "HEAD_TAIL" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.post("https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"HEAD_TAIL\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'HEAD_TAIL'})
};

fetch('https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"HEAD_TAIL\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites"

	payload := strings.NewReader("{\n  \"type\": \"HEAD_TAIL\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'HEAD_TAIL'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request POST \
  --url https://{commerce_studio_id}.experiencemanager.lucidworks.com/query-rewrites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "HEAD_TAIL"
}
'

{
  "type": "HEAD_TAIL",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "<string>",
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedBy": "<string>",
  "lastModified": "2023-11-07T05:31:56Z",
  "published": true,
  "version": "2023-11-07T05:31:56Z",
  "stagingFusionSyncStatus": {
    "lastSyncedVersion": "2023-11-07T05:31:56Z",
    "fusionVersion": "<string>"
  },
  "liveFusionSyncStatus": {
    "lastSyncedVersion": "2023-11-07T05:31:56Z",
    "fusionVersion": "<string>"
  },
  "markedForDeletion": true,
  "description": "<string>",
  "externalId": "<string>",
  "migratedId": "<string>",
  "surfaceForm": "<string>",
  "outputs": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

enum<string>[]

Optional additional fields to include in the response. Keep in mind that additional fields can slow the call and increase the response size.

Available options:

FUSION_SYNC_STATUS,

MIGRATION

Body

application/json

HeadTailQueryRewriteRequest
MisspellingQueryRewriteRequest
PhraseQueryRewriteRequest
RemoveWordsQueryRewriteRequest
SynonymQueryRewriteRequest

Replace underperforming queries with queries that produce higher click-through rates.

type

enum<string>

required

Query rewrite type. Determines which schema applies.

Available options:

HEAD_TAIL

description

string

Query rewrite description.

externalId

string

An optional ID set by external users of the API at creation time. Cannot be changed after creation.

published

boolean

default:false

Whether the rewrite is staged or published.

surfaceForm

string

The underperforming query to replace.

Example:

"tee shirts"

outputs

string[]

Query phrases that produce higher click-through rates to replace the underperforming query.

Example:

["tee shirts", "t-shirts"]

Response

201 - application/json

Created

HeadTailQueryRewriteSummary
MisspellingQueryRewriteSummary
PhraseQueryRewriteSummary
RemoveWordsQueryRewriteSummary
SynonymQueryRewriteSummary

Replace underperforming queries with queries that produce higher click-through rates.

type

enum<string>

required

Query rewrite type. Determines which schema applies.

Available options:

HEAD_TAIL

string<uuid>

Entity ID.

createdBy

string

User who created the entity.

creationDate

string<date-time>

Date when the entity was created.

lastModifiedBy

string

User who last updated the entity.

lastModified

string<date-time>

Date when the entity was last updated.

published

boolean

Whether the rewrite is staged or published.

version

string<date-time>

The version of this rewrite for synchronization purposes. Not the same as lastModified, and not used for If-Match in the API.

stagingFusionSyncStatus

FusionSyncStatusV2Summary · object

Status of this content's synchronization.

Show child attributes

liveFusionSyncStatus

FusionSyncStatusV2Summary · object

Status of this content's synchronization.

Show child attributes

markedForDeletion

boolean

True if this rewrite is marked for deletion but has not yet been fully removed from the system. This should only show up as true in rare cases. The system is supposed to resolve this situation eventually. Rewrites in this state (true) should not show up in the listing endpoints (other than GET by ID) unless explicitly requested to be included. Intended for troubleshooting purposes.

description

string

Rewrite description.

externalId

string

An optional ID set by external users of the API at creation time. Cannot be changed after creation.

migratedId

string

If this was originally migrated from another system, this field shows the ID of the original rewrite.

surfaceForm

string

The underperforming query to replace.

outputs

string[]

Query phrases that produce higher click-through rates to replace the underperforming query.

Authentication

Async Chunking

Async Prediction

Commerce Studio Rules & Rewrites

Platform Signals

Prediction

Prompt Preview

Tokenization

Use Case

Typeahead

Create a query rewrite

Authorizations

Query Parameters

Body

Response