Skip to main content
POST
/
api
/
v1
/
schema
/
search
search entities
curl --request POST \
  --url https://api.example.com/api/v1/schema/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "from": 0,
  "size": 10,
  "where": "field1='value' and field2<>'value2'",
  "sort": [
    {
      "field": "timestamp",
      "order": "Asc"
    }
  ],
  "trackTotal": false
}
EOF
{
  "data": [
    {
      "id": 1,
      "createdAt": 123,
      "updatedAt": 123,
      "status": "ACTIVE",
      "title": "<string>",
      "name": "<string>",
      "version": "0.0.1",
      "description": "Detector schema description example",
      "author": "<string>",
      "icon": "<string>",
      "tags": [
        "<string>"
      ],
      "networkTags": [
        "<string>"
      ],
      "faq": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "schema": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "title": "Product",
        "description": "Json schema example",
        "type": "object",
        "properties": {
          "name": {
            "description": "String property example",
            "type": "string"
          },
          "version": {
            "description": "Integer property example",
            "type": "integer",
            "exclusiveMinimum": 0
          }
        },
        "required": [
          "name",
          "version"
        ]
      },
      "uiSchema": {}
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.extractor.live/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authentication

Body

application/json
from
integer<int32>
default:0

Starting document offset

Required range: x >= 0
Example:

0

size
integer<int32>
default:10

The number of hits to return

Required range: 0 <= x <= 10000
Example:

10

where
string

Query string to search for data. Represent SQL 'where'

Example:

"field1='value' and field2<>'value2'"

sort
object[]

Sorting for the search

Minimum array length: 1
trackTotal
boolean
default:false

Return total results field if true

Response

200 - application/json

OK

data
object[]

Response data

total
integer<int64>

Total amount of document available for this request