Elasticsearch DSL

employee api will be deprecated on august 6th until then, you must transfer to a base employee api docid\ gobtmn jebqrtgr8akb1w read all about the benefits and changes base employee api docid\ zhyxkcw5ssxx1p94ejuwl data type employee query type elasticsearch domain specific language (es dsl) url https //api coresignal com/cdapi /v2/member/search/es dsl overview use the /v2/member/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 employee data, enabling you to write more sophisticated queries than using the /v2/member/search/filter endpoint elasticsearch schema https //docs coresignal com/api/employee api esdsl endpoint#bthu4 refer to the employee api elasticsearch schema sorting options https //docs coresignal com/api/employee api esdsl endpoint#wf27e information about possible sorting options limitations https //docs coresignal com/api/employee api esdsl endpoint#u58u5 information about endpoint limitations elasticsearch schema request examples https //docs coresignal com/api/employee api requests esdsl test out the endpoint with suggested examples we stopped updating the professional network skill information in april 2018, as the information was removed from public profiles "mappings" { "properties" { "id" { "type" "long" }, "name" { "type" "text" }, "first name" { "type" "text" }, "last name" { "type" "text", }, "title" { "type" "text" }, "user generated headline" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "url" { "type" "text", "fields" { "exact" { "type" "keyword", } } }, "hash" { "type" "keyword", }, "location" { "type" "text" }, "industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "summary" { "type" "text" }, "connections" { "type" "keyword", }, "recommendations count" { "type" "long", "null value" 1 }, "logo url" { "type" "keyword", }, "last response code" { "type" "long", "null value" 1, }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "outdated" { "type" "byte", }, "deleted" { "type" "byte", }, "country" { "type" "keyword", "null value" "null" }, "connections count" { "type" "long", "null value" 1 }, "experience count" { "type" "long", "null value" 1 }, "member shorthand name" { "type" "keyword" }, "member shorthand name hash" { "type" "keyword", }, "canonical url" { "type" "text", "fields" { "exact" { "type" "keyword" } } }, "canonical hash" { "type" "keyword" }, "canonical shorthand name" { "type" "keyword" }, "canonical shorthand name hash" { "type" "keyword" }, "member also viewed collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "title" { "type" "text" }, "location" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member awards collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "issuer" { "type" "text" }, "description" { "type" "text" }, "date" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member certifications collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "authority" { "type" "text" }, "url" { "type" "keyword" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "deleted" { "type" "byte" } } }, "member courses collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "position" { "type" "text" }, "courses" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member courses suggestion collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "course suggestion id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member courses suggestion list" { "properties" { "id" { "type" "long" }, "name" { "type" "keyword" }, "hash" { "type" "keyword" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member education collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text", "fields" { "raw" { "type" "keyword", "null value" "null" } } }, "subtitle" { "type" "text" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "activities and societies" { "type" "text" }, "description" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "school url" { "type" "text", "fields" { "exact" { "type" "keyword" } } } } }, "member experience collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "location" { "type" "text", }, "company name" { "type" "text", "fields" { "raw" { "type" "keyword", "null value" "null" } } }, "company url" { "type" "keyword" }, "company url shorthand name" { "type" "keyword" }, "company url canonical shorthand name" { "type" "keyword" }, "company industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company website" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" }, "domain only" { "type" "text" } } }, "company employees count" { "type" "unsigned long" }, "company size" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "duration" { "type" "text" }, "description" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "order in profile" { "type" "long" }, "company id" { "type" "long" } } }, "member groups collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "keyword" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member interests collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "interest id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member interest list" { "properties" { "id" { "type" "long" }, "interest" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member languages collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "language id" { "type" "long" }, "proficiency id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member language list" { "properties" { "id" { "type" "long" }, "language" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } }, "member language proficiency list" { "properties" { "id" { "type" "long" }, "proficiency" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member organizations collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "organization" { "type" "keyword" }, "position" { "type" "keyword" }, "description" { "type" "text" }, "date from" { "type" "keyword" }, "date to" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member patents collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "status id" { "type" "long" }, "inventors" { "type" "text" }, "date" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "url" { "type" "keyword" }, "description" { "type" "text" }, "valid area" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member patent status list" { "properties" { "id" { "type" "long" }, "status" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member posts see more urls collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member projects collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "url" { "type" "keyword" }, "description" { "type" "text" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "team members" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member publications collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "publisher" { "type" "keyword" }, "date" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000", }, "description" { "type" "text" }, "authors" { "type" "text" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member recommendations collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "recommendation" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member similar profiles collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member skills collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "skill id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member skill list" { "properties" { "id" { "type" "long" }, "skill" { "type" "text" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member test scores collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "date" { "type" "keyword" }, "description" { "type" "text" }, "score" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member volunteering cares collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "care id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering care list" { "properties" { "id" { "type" "long" }, "care" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering opportunities collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "opportunity id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering opportunity list" { "properties" { "id" { "type" "long" }, "opportunity" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering positions collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "organization" { "type" "text" }, "role" { "type" "keyword" }, "cause id" { "type" "long" }, "date from" { "type" "keyword" }, "date to" { "type" "keyword" }, "duration" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "description" { "type" "text" }, "organization url" { "type" "keyword" }, "member volunteering positions cause list" { "properties" { "id" { "type" "long" }, "cause" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering supports collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "support id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering support list" { "properties" { "id" { "type" "long" }, "support" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member websites collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "website" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member hidden status collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "is hidden" { "type" "byte" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } } } } sorting options 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 { "query" {}, "sort" \[ null ] } sort by score { "query" { "match" { "name" { "query" "john doe", "operator" "and" } } }, "sort" \[ " score" ] } sort by id { "query" { "match" { "name" { "query" "john doe", "operator" "and" } } }, "sort" \[ "id" ] } all personal 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 no matter the content of the query, the search only returns the record id (like all other search endpoints) queries in this endpoint are limited to 15,000 characters search returns 1000 results per page the maximum number of clauses a booleanquery can contain (number of boolean operators within the query) is 1024 more information on elasticsearch dsl do your elasticsearch dsl endpoints support analytics features? no, the analytics features are not supported in our elasticsearch dsl endpoints is it possible to search for a boolean value? yes the elastic search query itself includes a parameter bool that indicates to return results if they meet the criteria is there a way to exclude results? use an elastic search boolean query with a must not clause for example, the following query will search for all employees with current or past experience in a specific company (company id 5181133 )and exclude all employees with experience in a specific (company id 3252082) example query { "query" { "nested" { "path" "employee experience collection", "query" { "bool" { "must" \[ { "query string" { "query" 5181133, "default field" "employee experience collection company id", "default operator" "and" } }, { "bool" { "must not" \[ { "query string" { "query" 3252082, "default field" "employe experience collection company id", "default operator" "and" } } ] } } ] } } } } }