Add a Client

Follow the steps to add a new client

You need to fill add client form at Add Client, where following fields are required.

Form Fields

name
string
required

Name of your site/app.

Example: thesearchx

Datasource Type
JSON | CSV | SHOPIFY | STRAPI | GRAPHQL
required

Select your Datasource Format

Example: JSON

Embedding Fields
FieldName(String) : Priority(Number)
required

Field you want to search on in your data and it’s priority. If you want to search on nested field then you have to give nested path of the that field.

For example your data object is following:

example.json
{
  "title": "thesearchx",
  "category": "Search",
  "metadata": {
    "description": "Some Search Description",
    "count": 300
  }
}

Here, If you want to search on title and description so you have to write Field Name as title and metadata.description and priority as number.

Priority is the number for giving priority to the field.

Identifier
string
required

Unique Identifier of your data

Example: id

Entity URL
string
required

Link to Fetch the data. For example: If your data format is JSON then you have to give then link from where JSON data is readable

Example: https://thesearchx.com

Fields Required Based on Datasource Format

Shpofy Token | Strapi Token | GraphQL Token
string

Required for SHOPIFY, STRAPI and GRAPHQL data to access the data

Example: abcdefghijklmnso823483ydwjdbewhoi3h9

GraphQL Query Key
string

Required for GRAPHQL data.

Example: searchProducts

GraphQL Query
string

Required for GRAPHQL data. Write GraphQL Query in Given Text area at Form.

Example:

Example.graphql
query getTodos {
  todos {
    title
  }
}
GraphQL Variable JSON
Object

Required for GRAPHQL data. Write GraphQL Variable JSON in Given Text area at Form.

Example:

Example.json
{
  "filter": {
    "status": {
      "eq": "ENABLED"
    }
  },
  "limit": 50
}