Datasets

This parameter specifies the private key you’ll need for Piloterr access.

This parameter specifies the query to search for. Based on Elasticsearch Query DSL.

Examples:

1. Match query:

{
  "match": {
    "name": "OpenAI"
  }
}

2. Multi-match query:

{
  "multi_match": {
    "query": "artificial intelligence",
    "fields": ["name", "description"]
  }
}

3. Range query:

{
  "range": {
    "founded": {
      "gte": "2010-01-01",
      "lte": "2020-12-31"
    }
  }
}

4. Bool query (combining multiple conditions):

{
  "bool": {
    "must": [
      { "match": { "company_type": "for profit" } },
      { "range": { "staff_range": { "gte": "501" } } }
    ],
    "should": [
      { "match": { "description": "machine learning" } },
      { "match": { "description": "artificial intelligence" } }
    ],
    "must_not": [
      { "match": { "domain": "google.com" } }
    ]
  }
}

This parameter specifies the sort order of the results. Example:

[
  { "founded": "desc" },
  { "name.keyword": "asc" }
]

This will sort results by the “founded” field in descending order, then by the “name” field in ascending order.

This parameter specifies the number of results to return. Example:

20

This will return a maximum of 20 results.

This parameter specifies the starting index of the results. Example:

100

This will start returning results from the 101st match (useful for pagination).

List of data matching the query.

Total number of results matching the query.

Maximum relevance score of the matching results.