Client - The SearchX

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

string

required

Name of your site/app.Example: thesearchx

JSON | CSV | SHOPIFY | STRAPI | GRAPHQL

required

Select your Datasource FormatExample: JSON

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.

string

required

Unique Identifier of your dataExample: id

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 readableExample: https://thesearchx.com

Fields Required Based on Datasource Format

string

Required for SHOPIFY, STRAPI and GRAPHQL data to access the dataExample: abcdefghijklmnso823483ydwjdbewhoi3h9

string

Required for GRAPHQL data.Example: searchProducts

string

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

Example.graphql

query getTodos {
  todos {
    title
  }
}

Object

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

Example.json

{
  "filter": {
    "status": {
      "eq": "ENABLED"
    }
  },
  "limit": 50
}

​Add a Client

​Form Fields

​Fields Required Based on Datasource Format

Add a Client

Form Fields

Fields Required Based on Datasource Format