Get

GET

api

search_engines

{hashid}

indices

{name}

Get

curl --request GET \
  --url https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name} \
  --header 'Authorization: <api-key>'

import requests

url = "https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}', 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://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "name": "product",
  "preset": "product",
  "options": {},
  "datasources": [
    {
      "type": "file",
      "options": {
        "url": "https://yourserver/your_data_feed.xml"
      }
    }
  ]
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "access_denied",
    "message": "Access denied"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "error": {
    "code": "too_many_requests",
    "message": "Too many requests"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "Internal server error"
  }
}

Authorizations

Authorization

string

header

default:Token <your_api_key>

required

Doofinder API key. The Token prefix is part of the header value, so enter it too — the field is sent verbatim as:

Authorization: Token <api_key>

Path Parameters

hashid

string

required

Unique id of a search engine.

Pattern: ^[a-f0-9]{32}$

name

string

required

Name of an index.

Pattern: ^[a-z][a-z0-9_]*$

Response

Index retrieved.

Set of options and parameters of an index. They define the way an index is built.

name

string

required

Name of the Index. It works as the index identifier.

Pattern: ^[a-z][a-z0-9_]*$

Example:

"product"

preset

enum<string>

required

Preset of the index. The preset defines a set of configuration parameters for the index like basic fields to be included, and field transformations. For instance, the product preset creates the best_price field.

Available options:

generic,

product,

page,

category

Example:

"product"

options

Index Options · object

Accepted for backwards compatibility but ignored.

datasources

Data Source · object[]

List of datasources of an index.

Show child attributes

Get

curl --request GET \
  --url https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name} \
  --header 'Authorization: <api-key>'

import requests

url = "https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}', 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://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{search_zone}-api.doofinder.com/api/v2/search_engines/{hashid}/indices/{name}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "name": "product",
  "preset": "product",
  "options": {},
  "datasources": [
    {
      "type": "file",
      "options": {
        "url": "https://yourserver/your_data_feed.xml"
      }
    }
  ]
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "access_denied",
    "message": "Access denied"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "error": {
    "code": "too_many_requests",
    "message": "Too many requests"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "Internal server error"
  }
}

Overview

Endpoints

Authorizations

Path Parameters

Response