Multi query items
curl --request POST \
--url https://query.enterspeed.com/v1 \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
[
{
"index": "products",
"name": "productData",
"filters": {
"and": [
{
"field": "title",
"operator": "contains",
"value": "*hoodie*",
"caseInsensitive": true
},
{
"or": [
{
"field": "isInStock",
"operator": "equals",
"value": true
},
{
"field": "allowPreorder",
"operator": "equals",
"value": true
}
]
}
]
},
"aliases": [
"productTile"
],
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"sort": [
{
"field": "price",
"order": "asc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"index": "products",
"name": "facets",
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"pagination": {
"pageSize": 0
}
}
]
'import requests
url = "https://query.enterspeed.com/v1"
payload = [
{
"index": "products",
"name": "productData",
"filters": { "and": [{
"field": "title",
"operator": "contains",
"value": "*hoodie*",
"caseInsensitive": True
}, { "or": [
{
"field": "isInStock",
"operator": "equals",
"value": True
},
{
"field": "allowPreorder",
"operator": "equals",
"value": True
}
] }] },
"aliases": ["productTile"],
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"sort": [
{
"field": "price",
"order": "asc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"index": "products",
"name": "facets",
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"pagination": { "pageSize": 0 }
}
]
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Length": "<content-length>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
'Content-Length': '<content-length>',
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
index: 'products',
name: 'productData',
filters: {
and: [
{field: 'title', operator: 'contains', value: '*hoodie*', caseInsensitive: true},
{
or: [
{field: 'isInStock', operator: 'equals', value: true},
{field: 'allowPreorder', operator: 'equals', value: true}
]
}
]
},
aliases: ['productTile'],
facets: [
{name: 'Categories', field: 'category', size: 20},
{name: 'In Stock', field: 'isInStock'}
],
sort: [{field: 'price', order: 'asc'}],
pagination: {page: 0, pageSize: 20}
},
{
index: 'products',
name: 'facets',
facets: [
{name: 'Categories', field: 'category', size: 20},
{name: 'In Stock', field: 'isInStock'}
],
pagination: {pageSize: 0}
}
])
};
fetch('https://query.enterspeed.com/v1', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://query.enterspeed.com/v1",
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([
[
'index' => 'products',
'name' => 'productData',
'filters' => [
'and' => [
[
'field' => 'title',
'operator' => 'contains',
'value' => '*hoodie*',
'caseInsensitive' => true
],
[
'or' => [
[
'field' => 'isInStock',
'operator' => 'equals',
'value' => true
],
[
'field' => 'allowPreorder',
'operator' => 'equals',
'value' => true
]
]
]
]
],
'aliases' => [
'productTile'
],
'facets' => [
[
'name' => 'Categories',
'field' => 'category',
'size' => 20
],
[
'name' => 'In Stock',
'field' => 'isInStock'
]
],
'sort' => [
[
'field' => 'price',
'order' => 'asc'
]
],
'pagination' => [
'page' => 0,
'pageSize' => 20
]
],
[
'index' => 'products',
'name' => 'facets',
'facets' => [
[
'name' => 'Categories',
'field' => 'category',
'size' => 20
],
[
'name' => 'In Stock',
'field' => 'isInStock'
]
],
'pagination' => [
'pageSize' => 0
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Length: <content-length>",
"Content-Type: application/json",
"X-Api-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://query.enterspeed.com/v1"
payload := strings.NewReader("[\n {\n \"index\": \"products\",\n \"name\": \"productData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"title\",\n \"operator\": \"contains\",\n \"value\": \"*hoodie*\",\n \"caseInsensitive\": true\n },\n {\n \"or\": [\n {\n \"field\": \"isInStock\",\n \"operator\": \"equals\",\n \"value\": true\n },\n {\n \"field\": \"allowPreorder\",\n \"operator\": \"equals\",\n \"value\": true\n }\n ]\n }\n ]\n },\n \"aliases\": [\n \"productTile\"\n ],\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"sort\": [\n {\n \"field\": \"price\",\n \"order\": \"asc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"index\": \"products\",\n \"name\": \"facets\",\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"pagination\": {\n \"pageSize\": 0\n }\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("Content-Length", "<content-length>")
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))
}HttpResponse<String> response = Unirest.post("https://query.enterspeed.com/v1")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Length", "<content-length>")
.header("Content-Type", "application/json")
.body("[\n {\n \"index\": \"products\",\n \"name\": \"productData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"title\",\n \"operator\": \"contains\",\n \"value\": \"*hoodie*\",\n \"caseInsensitive\": true\n },\n {\n \"or\": [\n {\n \"field\": \"isInStock\",\n \"operator\": \"equals\",\n \"value\": true\n },\n {\n \"field\": \"allowPreorder\",\n \"operator\": \"equals\",\n \"value\": true\n }\n ]\n }\n ]\n },\n \"aliases\": [\n \"productTile\"\n ],\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"sort\": [\n {\n \"field\": \"price\",\n \"order\": \"asc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"index\": \"products\",\n \"name\": \"facets\",\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"pagination\": {\n \"pageSize\": 0\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://query.enterspeed.com/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["Content-Length"] = '<content-length>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"index\": \"products\",\n \"name\": \"productData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"title\",\n \"operator\": \"contains\",\n \"value\": \"*hoodie*\",\n \"caseInsensitive\": true\n },\n {\n \"or\": [\n {\n \"field\": \"isInStock\",\n \"operator\": \"equals\",\n \"value\": true\n },\n {\n \"field\": \"allowPreorder\",\n \"operator\": \"equals\",\n \"value\": true\n }\n ]\n }\n ]\n },\n \"aliases\": [\n \"productTile\"\n ],\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"sort\": [\n {\n \"field\": \"price\",\n \"order\": \"asc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"index\": \"products\",\n \"name\": \"facets\",\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"pagination\": {\n \"pageSize\": 0\n }\n }\n]"
response = http.request(request)
puts response.read_body[
{
"status": 0,
"index": "products",
"name": "productData",
"totalResults": 200,
"results": [
{
"sku": "p-5427",
"name": "Running shoe",
"url": "/products/running-shoe/",
"_originId": "p-5427",
"_sourceGuid": "9f741916-19e3-4791-9ebd-701634ba9b75",
"_updatedAt": "2025-01-07T08:43:15.7351089Z",
"_views": {
"productTile": {
"sku": "p-5427",
"name": "Running shoe",
"url": "/products/running-shoe/",
"image": "/media/running-shoe.webp",
"shortDescription": "My short description of the product",
"price": 199.99
}
}
}
],
"facets": [
{
"name": "Categories",
"field": "category",
"groups": [
{
"value": "Caps",
"count": 8
},
{
"value": "Hoodies",
"count": 2
}
],
"isValid": true
}
],
"nextPageToken": "WyIyMDI0LTAxLTAxIiwiYWJjMTIzIl0="
}
][
{
"message": "Query is not valid",
"errors": [
"Operator not implemented: equal"
],
"status": 0
}
]{
"error": "Forbidden"
}The Query API is used to query items in an index, with this endpoint up to 5 queries can be requested in a single payload, each query defining the index to perform the lookup in.
POST
/
v1
Multi query items
curl --request POST \
--url https://query.enterspeed.com/v1 \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
[
{
"index": "products",
"name": "productData",
"filters": {
"and": [
{
"field": "title",
"operator": "contains",
"value": "*hoodie*",
"caseInsensitive": true
},
{
"or": [
{
"field": "isInStock",
"operator": "equals",
"value": true
},
{
"field": "allowPreorder",
"operator": "equals",
"value": true
}
]
}
]
},
"aliases": [
"productTile"
],
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"sort": [
{
"field": "price",
"order": "asc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"index": "products",
"name": "facets",
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"pagination": {
"pageSize": 0
}
}
]
'import requests
url = "https://query.enterspeed.com/v1"
payload = [
{
"index": "products",
"name": "productData",
"filters": { "and": [{
"field": "title",
"operator": "contains",
"value": "*hoodie*",
"caseInsensitive": True
}, { "or": [
{
"field": "isInStock",
"operator": "equals",
"value": True
},
{
"field": "allowPreorder",
"operator": "equals",
"value": True
}
] }] },
"aliases": ["productTile"],
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"sort": [
{
"field": "price",
"order": "asc"
}
],
"pagination": {
"page": 0,
"pageSize": 20
}
},
{
"index": "products",
"name": "facets",
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{
"name": "In Stock",
"field": "isInStock"
}
],
"pagination": { "pageSize": 0 }
}
]
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Length": "<content-length>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
'Content-Length': '<content-length>',
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
index: 'products',
name: 'productData',
filters: {
and: [
{field: 'title', operator: 'contains', value: '*hoodie*', caseInsensitive: true},
{
or: [
{field: 'isInStock', operator: 'equals', value: true},
{field: 'allowPreorder', operator: 'equals', value: true}
]
}
]
},
aliases: ['productTile'],
facets: [
{name: 'Categories', field: 'category', size: 20},
{name: 'In Stock', field: 'isInStock'}
],
sort: [{field: 'price', order: 'asc'}],
pagination: {page: 0, pageSize: 20}
},
{
index: 'products',
name: 'facets',
facets: [
{name: 'Categories', field: 'category', size: 20},
{name: 'In Stock', field: 'isInStock'}
],
pagination: {pageSize: 0}
}
])
};
fetch('https://query.enterspeed.com/v1', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://query.enterspeed.com/v1",
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([
[
'index' => 'products',
'name' => 'productData',
'filters' => [
'and' => [
[
'field' => 'title',
'operator' => 'contains',
'value' => '*hoodie*',
'caseInsensitive' => true
],
[
'or' => [
[
'field' => 'isInStock',
'operator' => 'equals',
'value' => true
],
[
'field' => 'allowPreorder',
'operator' => 'equals',
'value' => true
]
]
]
]
],
'aliases' => [
'productTile'
],
'facets' => [
[
'name' => 'Categories',
'field' => 'category',
'size' => 20
],
[
'name' => 'In Stock',
'field' => 'isInStock'
]
],
'sort' => [
[
'field' => 'price',
'order' => 'asc'
]
],
'pagination' => [
'page' => 0,
'pageSize' => 20
]
],
[
'index' => 'products',
'name' => 'facets',
'facets' => [
[
'name' => 'Categories',
'field' => 'category',
'size' => 20
],
[
'name' => 'In Stock',
'field' => 'isInStock'
]
],
'pagination' => [
'pageSize' => 0
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Length: <content-length>",
"Content-Type: application/json",
"X-Api-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://query.enterspeed.com/v1"
payload := strings.NewReader("[\n {\n \"index\": \"products\",\n \"name\": \"productData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"title\",\n \"operator\": \"contains\",\n \"value\": \"*hoodie*\",\n \"caseInsensitive\": true\n },\n {\n \"or\": [\n {\n \"field\": \"isInStock\",\n \"operator\": \"equals\",\n \"value\": true\n },\n {\n \"field\": \"allowPreorder\",\n \"operator\": \"equals\",\n \"value\": true\n }\n ]\n }\n ]\n },\n \"aliases\": [\n \"productTile\"\n ],\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"sort\": [\n {\n \"field\": \"price\",\n \"order\": \"asc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"index\": \"products\",\n \"name\": \"facets\",\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"pagination\": {\n \"pageSize\": 0\n }\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("Content-Length", "<content-length>")
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))
}HttpResponse<String> response = Unirest.post("https://query.enterspeed.com/v1")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Length", "<content-length>")
.header("Content-Type", "application/json")
.body("[\n {\n \"index\": \"products\",\n \"name\": \"productData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"title\",\n \"operator\": \"contains\",\n \"value\": \"*hoodie*\",\n \"caseInsensitive\": true\n },\n {\n \"or\": [\n {\n \"field\": \"isInStock\",\n \"operator\": \"equals\",\n \"value\": true\n },\n {\n \"field\": \"allowPreorder\",\n \"operator\": \"equals\",\n \"value\": true\n }\n ]\n }\n ]\n },\n \"aliases\": [\n \"productTile\"\n ],\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"sort\": [\n {\n \"field\": \"price\",\n \"order\": \"asc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"index\": \"products\",\n \"name\": \"facets\",\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"pagination\": {\n \"pageSize\": 0\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://query.enterspeed.com/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["Content-Length"] = '<content-length>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"index\": \"products\",\n \"name\": \"productData\",\n \"filters\": {\n \"and\": [\n {\n \"field\": \"title\",\n \"operator\": \"contains\",\n \"value\": \"*hoodie*\",\n \"caseInsensitive\": true\n },\n {\n \"or\": [\n {\n \"field\": \"isInStock\",\n \"operator\": \"equals\",\n \"value\": true\n },\n {\n \"field\": \"allowPreorder\",\n \"operator\": \"equals\",\n \"value\": true\n }\n ]\n }\n ]\n },\n \"aliases\": [\n \"productTile\"\n ],\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"sort\": [\n {\n \"field\": \"price\",\n \"order\": \"asc\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"pageSize\": 20\n }\n },\n {\n \"index\": \"products\",\n \"name\": \"facets\",\n \"facets\": [\n {\n \"name\": \"Categories\",\n \"field\": \"category\",\n \"size\": 20\n },\n {\n \"name\": \"In Stock\",\n \"field\": \"isInStock\"\n }\n ],\n \"pagination\": {\n \"pageSize\": 0\n }\n }\n]"
response = http.request(request)
puts response.read_body[
{
"status": 0,
"index": "products",
"name": "productData",
"totalResults": 200,
"results": [
{
"sku": "p-5427",
"name": "Running shoe",
"url": "/products/running-shoe/",
"_originId": "p-5427",
"_sourceGuid": "9f741916-19e3-4791-9ebd-701634ba9b75",
"_updatedAt": "2025-01-07T08:43:15.7351089Z",
"_views": {
"productTile": {
"sku": "p-5427",
"name": "Running shoe",
"url": "/products/running-shoe/",
"image": "/media/running-shoe.webp",
"shortDescription": "My short description of the product",
"price": 199.99
}
}
}
],
"facets": [
{
"name": "Categories",
"field": "category",
"groups": [
{
"value": "Caps",
"count": 8
},
{
"value": "Hoodies",
"count": 2
}
],
"isValid": true
}
],
"nextPageToken": "WyIyMDI0LTAxLTAxIiwiYWJjMTIzIl0="
}
][
{
"message": "Query is not valid",
"errors": [
"Operator not implemented: equal"
],
"status": 0
}
]{
"error": "Forbidden"
}Headers
Api key to validate your environment.
Example:
"environment-1637c4d0-e878-4738-b866-152106a4f88c"
The length of the message body, in bytes (this header is automatically added by most clients).
Body
application/json
The query consists of a list of query objects, on the format just like when quering items in a single index, so refer to this section when looking into filters, sorting, pagination etc.
The only thing that differs with these query objects, is an addition of an index and a name field, so you per query can define which index you want to perform the query against and also name the individual query. This means that this service can perform multiple queries on the same index, or perform queries on multiple indicies in one request, and also give you the ability to name queries for easier identification of the resulting result sets.
Note
The request payload can at most take 5 queries in one request.
Example:
[
{
"index": "products",
"name": "productData",
"filters": {
"and": [
{
"field": "title",
"operator": "contains",
"value": "*hoodie*",
"caseInsensitive": true
},
{
"or": [
{
"field": "isInStock",
"operator": "equals",
"value": true
},
{
"field": "allowPreorder",
"operator": "equals",
"value": true
}
]
}
]
},
"aliases": ["productTile"],
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{ "name": "In Stock", "field": "isInStock" }
],
"sort": [{ "field": "price", "order": "asc" }],
"pagination": { "page": 0, "pageSize": 20 }
},
{
"index": "products",
"name": "facets",
"facets": [
{
"name": "Categories",
"field": "category",
"size": 20
},
{ "name": "In Stock", "field": "isInStock" }
],
"pagination": { "pageSize": 0 }
}
]
Response
When one or more queries results in a valid response a 200 response is returned. If any of the other requested queries fails, either due to validation errors or other issues, the error message will be returned as part of the response.
- Option 1
- Option 2
- Option 3
- Option 4
Example:
0
The index name which were given for the query in the request.
Example:
"products"
The query name which were given for the query in the request.
Example:
"productData"
The total number of results matched by query.
Example:
200
List of items from the index matched by the query provided.
Built in fields are prefixed with underscore (_).
List of aggregated field values based on the requested facet fields.
Continuation token for the next page of results. Pass this value in the pagination.nextPageToken field of the next request. null when no further results exist.
Example:
"WyIyMDI0LTAxLTAxIiwiYWJjMTIzIl0="
Was this page helpful?
⌘I