Base Employee API
New feature: Base Employee API replaces Employee API Impacted API and entity: Employee API and Base Employee API Important dates:
- April 9th β Base Employee API released. Start of migration period
- May 9th (30 days after release) β Subscriptions (Webhooks) will no longer be accepted for Employee API entity
- August 6th (4 months after release) β Employee API endpoints will be fully deprecated; Clients will have to be fully migrated to Base Employee API onwards.
The transition period is 4 months, during which Employee API and Base Employee API will be available. After August 6th, Employee API will no longer be supported, and Base Employee API will intercept.
Furthermore, you will not be able to create new subscriptions using Employee API after 30 days from Base Employee API release date. This means that after May 9th, the following Employee API webhooks will no longer be supported:
- /v1/subscriptions/professional_network/member/id_file
- /v1/subscriptions/professional_network/member/filter
- /v1/subscriptions/professional_network/member/es_dsl
Regarding this change, you will have to switch from Employee API to renewed Base Employee API. The following points remark what is changing:
- New Elasticsearch schema and data structure with changed/removed/renamed fields
- Search Filter endpoint filter naming changes
- Endpoint changes
- New ID mapping endpoint to resolve ID changes between two structures
- Changed Bulk Collect and Subscriptions behaviour
Several key improvements regarding this change:
- New data fields: Follower_count, Checked_at, Services
- New collections: Historical employee identifier values (Historical_IDs, Shorthand_names), Activity
- Fewer employee duplicates: The new API introduces a systematic approach to how clients can handle duplicates using our historical data
- Enhanced QA: Improved quality assurance for more reliable data
- Streamlined data: Removed unnecessary fields and renewed updating logic for all collections
- Webhook subscriptions update: New webhooks will be sent daily
Elasticsearch schema changes include new structure with removed, added, or renamed fields. This is important for /v1/professional_network/employee_base/search/es_dsl endpoint users.
To compare the improvements, please refer to the imported table below.
The important part to mark is that this table includes "index" columns. This notes that a specific field is searchable if there is an index (Y). If there is no index (N) in the Base Employee API, it will not be searchable, whereas in Employee API, every field is searchable, even with no index.
Base Employee API Elasticsearch schema is available here:
For comparison, find Employee API Elasticsearch schema below:
Several search filter aspects are also pointed out. All filters are the same, but some of them have different names. This is important for /v1/professional_network/employee_base/search/filter endpoint users.
Study the following table for comparison.
The table below compares both APIs' endpoints.
Request type | Employee API | Base Employee API |
|---|---|---|
POST | /v1/professional_network/member/search/filter | /v1/professional_network/employee_base/search/filter |
POST | /v1/professional_network/member/search/es_dsl | /v1/professional_network/employee_base/search/es_dsl |
POST | β | /v1/professional_network/employee_base/map/ids |
GET | /v1/professional_network/member/collect/{member_id} | /v1/professional_network/employee_base/collect/{employee_id} |
GET | /v1/professional_network/member/collect/{shorthand_name} | /v1/professional_network/employee_base/collect/{shorthand_name} |
Since the IDs of Employee API will not be the same as Base Employee API, we've prepared a mapping endpoint for mapping purposes. This means that the valid, non-duplicate data you already have can be used in the Base Employee API. The mapping endpoint is listed below:
- /v1/professional_network/employee_base/map/ids
Information on how to use the endpoint is available in the Mapping Endpointο»Ώ topic.
Dictionary, or data output, also has some alterations. The table below marks all changes β new data points, renamed, or deleted fields.
In Base Employee API, id_file will no longer be supported. Instead, ids will have to be passed as a list. Note: Search Filter / ES DSL query matching up to 10,000 IDs.
When creating a bulk collect data request or a new subscription based on ES DSL query to the new Base Employee endpoints, we strongly advise including the following clause in your query:
This ensures that you are getting the most out of our new systematic approach to exclude duplicate records, which weβre able to resolve to the same profile.
The table below compares both APIs' Bulk Collect endpoints.
Request type | Employee API | Base Employee API |
|---|---|---|
POST | /v1/professional_network/member/bulk_collect/id_file | β/v1/professional_network/employee_base/bulk_collect/ids |
POST | /v1/professional_network/member/bulk_collect/es_dsl | /v1/professional_network/employee_base/bulk_collect/es_dsl |
POST | /v1/professional_network/member/bulk_collect/filter | /v1/professional_network/employee_base/bulk_collect/filter |
Currently, several data point collections will not be included in the results. This is relevant only for Bulk Collect requests. See the categories and data points below.
Action | Category | Data Point |
|---|---|---|
Excluded | ο»ΏPublicationsο»Ώ | authors |
Excluded | ο»ΏPatentsο»Ώ | inventors |
Excluded | ο»ΏProjectsο»Ώ | team_members |
The table below compares both APIs' webhook endpoints.
Request type | Employee API | Base Employee API |
|---|---|---|
POST | /v1/subscriptions/professional_network/member/id_file | β/v1/subscriptions/professional_network/employee_base/ids |
POST | /v1/subscriptions/professional_network/member/es_dsl | /v1/subscriptions/professional_network/employee_base/es_dsl |
POST | /v1/subscriptions/professional_network/member/filter | /v1/subscriptions/professional_network/employee_base/filter |
ο»Ώ