Search API

API change history

The Search API allows e-commerce websites to interact directly with the Faceted Search Engine.

Retrieve image search results.

A simple GET call to retrieve image search results (similar products) for the product identifier.

Try it

Request

Request URL

Request parameters

  • string

    The unique identifier of the Search box. This is a constant (GUID). You can access the btr GUID via the Prefixbox Admin Portal on the Edit Search Box page, Integration tab, under Tracker.

  • string

    The identifier of the product, for which similar products will be retrieved.

  • (optional)
    integer

    Format - int32. Format - int32. Specifies the number of search results per page to be retrieved in the request. If left empty the default page size will be applied.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns the image search results.

Representations

{
  "documents": [
    {
      "score": 0.0,
      "document": {}
    }
  ],
  "filters": [
    {
      "name": "string",
      "displayName": "string",
      "dataType": "string",
      "type": "range",
      "order": 0,
      "count": 0,
      "ranges": [
        {
          "min": 0.0,
          "max": 0.0,
          "filteredMin": 0.0,
          "filteredMax": 0.0
        }
      ],
      "values": [
        {
          "count": 0,
          "name": "string",
          "disabled": false
        }
      ],
      "disabled": false
    }
  ],
  "strategy": {
    "rank": 0,
    "searchMode": "All",
    "fuzzySensitiveness": "Off",
    "minimumFuzzyTermLength": 0,
    "enableFuzzyNumberMatch": true
  },
  "count": 0,
  "pageSize": 0,
  "isFuzzied": true,
  "originalQuery": "string",
  "alteredQuery": "string",
  "explainedAlteredQuery": {},
  "originalFilter": "string",
  "alteredFilter": "string",
  "facetType": "basic",
  "resultStatus": "resultFound",
  "resultCount": 0,
  "resultPerPage": 0,
  "searchParameters": {
    "filters": {
      "rangeFilters": [
        {
          "name": "string",
          "min": 0.0,
          "max": 0.0
        }
      ],
      "termFilters": [
        {
          "name": "string",
          "values": [
            "string"
          ]
        }
      ]
    },
    "facetType": "basic",
    "query": "string",
    "page": 0,
    "resultsPerPage": 0,
    "sorting": [
      {
        "name": "string",
        "order": "asc"
      }
    ]
  },
  "redirect": {
    "ruleId": 0,
    "campaignName": "string",
    "url": "string"
  },
  "banners": [
    {
      "ruleId": 0,
      "campaignName": "string",
      "position": "resultPageTop",
      "contents": [
        {
          "content": "string"
        }
      ]
    }
  ],
  "ads": {
    "ruleId": 0,
    "campaignName": "string",
    "adResults": [
      {
        "score": 0.0,
        "document": {}
      }
    ]
  },
  "promotionDetail": {
    "ruleId": 0,
    "highlighted": true,
    "campaignName": "string"
  },
  "intentClarification": {
    "ruleId": 0,
    "campaignName": "string",
    "pattern": "string",
    "clarifyingQuestion": "string",
    "intentTiles": [
      {
        "intentTileId": "string",
        "intentTileText": "string",
        "tile": "string"
      }
    ],
    "selectedTile": {
      "intentTileId": "string",
      "intentTileText": "string",
      "tile": "string"
    }
  }
}
{
  "type": "object",
  "properties": {
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "score": {
            "type": "number",
            "format": "double"
          },
          "document": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "nullable": true
          }
        }
      },
      "nullable": true
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "displayName": {
            "type": "string",
            "nullable": true
          },
          "dataType": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "enum": [
              "range",
              "value"
            ],
            "type": "string"
          },
          "order": {
            "type": "integer",
            "format": "int32"
          },
          "count": {
            "type": "integer",
            "format": "int32"
          },
          "ranges": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "min": {
                  "type": "number",
                  "format": "double"
                },
                "max": {
                  "type": "number",
                  "format": "double"
                },
                "filteredMin": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                },
                "filteredMax": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              }
            },
            "nullable": true
          },
          "values": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "count": {
                  "type": "integer",
                  "format": "int64",
                  "nullable": true
                },
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "disabled": {
                  "type": "boolean",
                  "default": false
                }
              }
            },
            "nullable": true
          },
          "disabled": {
            "type": "boolean",
            "default": false
          }
        }
      },
      "nullable": true
    },
    "strategy": {
      "type": "object",
      "properties": {
        "rank": {
          "type": "integer",
          "format": "int32"
        },
        "searchMode": {
          "enum": [
            "All",
            "Any"
          ],
          "type": "string"
        },
        "fuzzySensitiveness": {
          "enum": [
            "Off",
            "One",
            "Two"
          ],
          "type": "string"
        },
        "minimumFuzzyTermLength": {
          "type": "integer",
          "format": "int32"
        },
        "enableFuzzyNumberMatch": {
          "type": "boolean"
        }
      }
    },
    "count": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "pageSize": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "isFuzzied": {
      "type": "boolean",
      "nullable": true
    },
    "originalQuery": {
      "type": "string",
      "nullable": true
    },
    "alteredQuery": {
      "type": "string",
      "nullable": true
    },
    "explainedAlteredQuery": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "nullable": true
    },
    "originalFilter": {
      "type": "string",
      "nullable": true
    },
    "alteredFilter": {
      "type": "string",
      "nullable": true
    },
    "facetType": {
      "enum": [
        "basic",
        "adaptive",
        "semiAdaptive"
      ],
      "type": "string"
    },
    "resultStatus": {
      "enum": [
        "resultFound",
        "resultNotFound",
        "errorOccured",
        "redirect"
      ],
      "type": "string"
    },
    "resultCount": {
      "type": "integer",
      "format": "int64"
    },
    "resultPerPage": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "searchParameters": {
      "type": "object",
      "properties": {
        "filters": {
          "type": "object",
          "properties": {
            "rangeFilters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "min": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "max": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  }
                }
              },
              "nullable": true
            },
            "termFilters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "values": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  }
                }
              },
              "nullable": true
            }
          }
        },
        "facetType": {
          "enum": [
            "basic",
            "adaptive",
            "semiAdaptive"
          ],
          "type": "string"
        },
        "query": {
          "type": "string",
          "nullable": true
        },
        "page": {
          "type": "integer",
          "format": "int64",
          "nullable": true
        },
        "resultsPerPage": {
          "type": "integer",
          "format": "int64",
          "nullable": true
        },
        "sorting": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "nullable": true
              },
              "order": {
                "enum": [
                  "asc",
                  "desc"
                ],
                "type": "string"
              }
            }
          },
          "nullable": true
        }
      }
    },
    "redirect": {
      "type": "object",
      "properties": {
        "ruleId": {
          "type": "integer",
          "format": "int32"
        },
        "campaignName": {
          "type": "string",
          "nullable": true
        },
        "url": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "banners": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "type": "integer",
            "format": "int32"
          },
          "campaignName": {
            "type": "string",
            "nullable": true
          },
          "position": {
            "enum": [
              "resultPageTop",
              "resultPageBottom",
              "filterTop",
              "filterBottom",
              "resultsAndControlsTop",
              "betweenResultsAndControlsTop",
              "betweenResultsAndControlsBottom",
              "resultsAndControlsBottom"
            ],
            "type": "string"
          },
          "contents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "content": {
                  "type": "string",
                  "nullable": true
                }
              }
            },
            "nullable": true
          }
        }
      },
      "nullable": true
    },
    "ads": {
      "type": "object",
      "properties": {
        "ruleId": {
          "type": "integer",
          "format": "int32"
        },
        "campaignName": {
          "type": "string",
          "nullable": true
        },
        "adResults": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "score": {
                "type": "number",
                "format": "double"
              },
              "document": {
                "type": "object",
                "additionalProperties": {
                  "type": "object"
                },
                "nullable": true
              }
            }
          },
          "nullable": true
        }
      }
    },
    "promotionDetail": {
      "type": "object",
      "properties": {
        "ruleId": {
          "type": "integer",
          "format": "int32"
        },
        "highlighted": {
          "type": "boolean"
        },
        "campaignName": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "intentClarification": {
      "type": "object",
      "properties": {
        "ruleId": {
          "type": "integer",
          "format": "int32"
        },
        "campaignName": {
          "type": "string",
          "nullable": true
        },
        "pattern": {
          "type": "string",
          "nullable": true
        },
        "clarifyingQuestion": {
          "type": "string",
          "nullable": true
        },
        "intentTiles": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "intentTileId": {
                "type": "string",
                "nullable": true
              },
              "intentTileText": {
                "type": "string",
                "nullable": true
              },
              "tile": {
                "type": "string",
                "nullable": true
              }
            }
          },
          "nullable": true
        },
        "selectedTile": {
          "type": "object",
          "properties": {
            "intentTileId": {
              "type": "string",
              "nullable": true
            },
            "intentTileText": {
              "type": "string",
              "nullable": true
            },
            "tile": {
              "type": "string",
              "nullable": true
            }
          }
        }
      }
    }
  }
}

400 Bad Request

In case of invalid parameters.

Representations

string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.prefixbox.com/search/imagesearch?btr={btr}&identifier={identifier}?top={integer}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["top"] = "{integer}";
            var uri = "https://api.prefixbox.com/search/imagesearch?btr={btr}&identifier={identifier}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.prefixbox.com/search/imagesearch?btr={btr}&identifier={identifier}");

            builder.setParameter("top", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "top": "{integer}",
        };
      
        $.ajax({
            url: "https://api.prefixbox.com/search/imagesearch?btr={btr}&identifier={identifier}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.prefixbox.com/search/imagesearch?btr={btr}&identifier={identifier}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"top={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.prefixbox.com/search/imagesearch?btr={btr}&identifier={identifier}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'top' => '{integer}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'top': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.prefixbox.com')
    conn.request("GET", "/search/imagesearch?btr={btr}&identifier={identifier}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'top': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('api.prefixbox.com')
    conn.request("GET", "/search/imagesearch?btr={btr}&identifier={identifier}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.prefixbox.com/search/imagesearch?btr={btr}&identifier={identifier}')

query = URI.encode_www_form({
    # Request parameters
    'top' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body