Search Preview

Data type:

Query type:

URL:

Clean Company

Elasticsearch DSL

https://api.coresignal.com/cdapi/v2/company_clean/search/es_dsl/preview

---

Overview

Retrieve a limited set of fields from top-matching records in real time, and search suggestion features. Here, Clean Company API search /v2/company_clean/search/es_dsl/preview endpoint's usage is reviewed.

General information about search preview

Request query

See the request example of preview endpoint. Search Preview endpoints accept the same query structure as their corresponding Search endpoints.

Elasticsearch DSL request

curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_clean/search/es_dsl/preview' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
        "bool": {
            "should": [
                {
                    "query_string": {
                        "query": "Data",
                        "default_field": "name",
                        "default_operator": "and"
                    }
                }
            ]
        }
    }
}'

Response structure

Here is an overview of the fields that are retrieved using the Clean Company API search preview endpoints.

Data point	Description	Data type
id	Identification number	Integer
name	Company name	String
websites_professional_network_canonical	Canonical Professional network profile URL	String
website_main	Company's website	String
size_range	Company size category (determined by the number of employees)	String
industry	Company's industry	String
location_hq_country	Country the company is based in (as parsed by our in-house country parser)	String
logo	BASE64 encoded JPEG image of the company's logo	String
_score	Elasticsearch score	Float

Refer to the data example here:

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

Elasticsearch DSL response

    {
        "id": 12345678,
        "name": "Example Company",
        "websites_professional_network_canonical": "https://uk.professional-network.com/company/example-company",
        "websites_main": "http://example-company.co.uk",
        "size_range": "Myself Only",
        "industry": "Information Technology & Services",
        "location_hq_country": "United Kingdom",
        "logo": null,
        "_score": 10.123456
    },

Pagination

Example of the request using pagination query parameter page.

Elasticsearch DSL request

curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_clean/search/es_dsl/preview?page=4' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
        "bool": {
            "should": [
                {
                    "query_string": {
                        "query": "Data",
                        "default_field": "name",
                        "default_operator": "and"
                    }
                }
            ]
        }
    }
}'