Search Preview

Data type:

Query type:

URL:

Multi-source Employee

Elasticsearch DSL

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


Overview

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

Request queries

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/employee_multi_source/search/es_dsl/preview' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
        "bool": {
            "should": [
                {
                    "query_string": {
                        "query": "Python",
                        "default_field": "summary",
                        "default_operator": "and"
                    }
                }
            ]
        }
    }
}'

Response structure

Here is an overview of the fields that are retrieved using the Multi-source Employee API search preview endpoints.

Data point
Description
Data type

id

Identification number

Integer

full_name

Employee's full name

String

professional_network_url

Most recent Professional network profile URL

String

headline

Profile headline

String

location_full

Employee's full location

String

location_country

Associated country

String

connections_count

Count of profile connections

Integer

followers_count

Count of profile followers

Integer

company_name

Company name. Data is from experience category

String

company_professional_network_url

Company's Professional network URL. Data is from experience category

String

company_website

Company's website. Data is from experience category

String

company_industry

Company's industry. Data is from experience category

String

active_experience_title

Title of employee's current position

String

active_experience_department

A list of employee's departments, based on actve_position_title

String

active_experience_management_level

A list of employee's management levels, based on active_experience_title

String

company_hq_full_address

Full address of the company's headquarters. Data is from experience category

String

company_hq_country

The country where the company's headquarters are located. Data is from experience category

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": 1234566,
        "full_name": "John Doe",
        "professional_network_url": "https://www.professional-network.com/in/john-doe",
        "headline": "Python Automation Engineer, QA automation",
        "location_full": "United States",
        "location_country": "United States",
        "connections_count": 100,
        "followers_count": 110,
        "company_name": "Example Company",
        "company_professional_network_url": "https://www.professional-network.com/company/example-company",
        "company_website": "https://www.example-company.com",
        "company_industry": "IT System Custom Software Development",
        "active_experience_title": "Python Automation Engineer",
        "active_experience_department": "Engineering and Technical",
        "active_experience_management_level": "Specialist",
        "company_hq_full_address": "123 Example st; New York, US",
        "company_hq_country": "United States",
        "_score": 8.01234
    },

Pagination

Example of the request using pagination query parameter page.

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

Last updated

Was this helpful?