Company API
Endpoints

Elasticsearch DSL

6min

Data type: Company Query type: Elasticsearch Domain Specific Language (ES DSL) URL: /v1/professional_network/company/search/es_dsl.

Overview

Use the /v1/professional_network/company/search/es_dsl endpoint for more sophisticated queries. For example, you can use fuzzy and wildcard queries in the endpoint. Additionally, the endpoint allows you to operate filters that mimic our company data, enabling you to write more sophisticated queries than using the /v1​/professional_network/company/search​/filter endpoint.

Endpoint schema


You can choose between two sorting options: sort by ID or score. If you omit the sort part entirely, the sorting will be by ID by default.

Sorting by score enables you to view search results in order of relevance, with the most relevant items appearing first.

Sorting by ID arranges the list of IDs in ascending order, starting from the smallest value and progressing to the largest.

Choose the sorting type in the sort section of the endpoint payload:

Endpoint payload
Sort by score
Sort by id


All company information mentioned within this context is entirely fictional and is solely intended for illustrative purposes.

Limitations

  • We do not own the functions and syntax that this endpoint operates in. For all specific Elasticsearch DSL information, please refer to their official documentation.
  • The endpoint accepts the query object of a standard Elasticsearch request. Refer to the request examples here.
  • No matter the content of the query, the search only returns record IDs (like all other Search endpoints).
  • Queries in this endpoint are limited to 15,000 characters.
  • The maximum number of clauses a BooleanQuery can contain (number of boolean operators within the query) is 1024.

More information on Elasticsearch DSL

No, the analytics features are not supported in our Elasticsearch DSL endpoints.

Yes. The elastic search query itself includes a parameter bool that indicates to return results if they meet the criteria.

Use an elastic search boolean query with a must_not clause.



Updated 16 Sep 2024
Did this page help you?