Data Dictionary: Clean Employee API
Data dictionary for data retrieved using Clean Employee API endpoints.
This data dictionary shows all available data points, explains their values, and provides data samples from the Clean Employee API data.
The data provided in the samples is strictly intended for illustrative purposes, allowing you to visualize its appearance and format.
Data point | Processing | Description | Data type |
---|---|---|---|
last_updated | Cleaned | Date the record was last updated | String |
is_deleted | Raw | Indicates whether the profile was accessible: 1 – deleted or private 0 – publicly available | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
id | Raw | Employee record identification key in our database | Integer |
full_name | Cleaned | Full name | String |
name_first | Raw | First name | String |
name_middle | Enriched | Middle name | String |
name_last | Enriched | Last name | String |
websites_professional_network | Raw | Professional network profile URL | String |
shorthand_names | Raw | Historical shorthand name list | Array of strings |
picture_url | Raw | Profile picture URL | String |
follower_count | Raw | Profile follower count | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
skills | Enriched | Skill list | Array of strings |
Data point | Processing | Description | Data type |
---|---|---|---|
description | Raw | Job position description | String |
company_id | Enriched | Employer's identification key | Integer |
headline | Raw | Title found in the profile headline | String |
generated_headline | Raw | A user-written headline that can be found in web search, also viewed and other publicly available spaces. It serves the same purpose as the title but is derived from a different source, potentially providing more accurate and up-to-date profile information. This field should be used in place title as it reflects the latest user activity. | String |
job_title | Cleaned | Current job position title | String |
is_decision_maker | Enriched | Indicates whether the employee is a decision-maker based on job_title 1 – Employee is marked a decision-maker in the current role 0 – Employee is not marked a decision-maker in the current role | Integer |
job_description | Raw | Current job position description | String |
total_experience_duration | Enriched | Summed up experience. Converted to Professional network-like text, e.g., 2 Years 11 Months | String |
total_experience_duration_months | Enriched | Summed up experience (displayed as months) | Integer |
The experience table is mapped with our historical data due to source's policy of hiding the work experience on certain employees' profiles.
Data point | Processing | Description | Data type |
---|---|---|---|
experience | - | Work experience details | Array of objects |
company_id | Raw | Workplace (company) identifier in our database | Integer |
date_from | Cleaned | Employment start date | String (date) |
date_from_year | Cleaned | Employment start year | Integer |
date_from_month | Cleaned | Employment start month | Integer |
date_to | Cleaned | Employment end date | String (date) |
date_to_year | Cleaned | Employment end year | Integer |
date_to_month | Cleaned | Employment end month | Integer |
company_url | Raw | Employer's professional network profile URL | String |
company_name | Raw | Employer company | |
title | Raw | Job title | String |
department | Enriched | Associated department | String |
management_level | Enriched | Management level | String |
description | Cleaned | Job description | String |
order_in_profile | Raw | Record order as seen on the employee's profile | Integer |
duration | Enriched | Employment duration | String (date) |
duration_months | Cleaned | Employment duration in months | Integer |
location | Cleaned | Job/workplace location | String |
Information in the table below is enriched using Clean and Base Company datasets.
Data point | Description | Data type |
---|---|---|
experience | Employer (company) details | Array of objects |
company_type | Type | String |
company_founded | Founding year | String |
company_followers_count | Follower count | Integer |
company_website | Official website | String |
company_facebook_url | Facebook profile URL | Array of strings |
company_twitter_url | Twitter profile URL | Array of strings |
company_professional_network_url | Professional network profile URL | String |
company_size_range | Size (as a range) | String |
company_size_employees_count | Headcount | Integer |
company_industry | Associated industry | String |
company_location_hq_full_address | Full address of company headquarters | String |
company_location_hq_country | Headquarters location (country) | String |
company_location_hq_regions | Headquarters location (regions) | Array of strings |
company_location_hq_country_iso2 | Headquarters location (country, ISO alpha-2 code) | String |
company_location_hq_country_iso3 | Headquarters location (country, ISO alpha-3 code) | String |
company_location_hq_city | Headquarters location (city) | String |
company_location_hq_state | Headquarters location (state) | String |
company_location_hq_street | Headquarters location (street) | String |
company_location_hq_zipcode | Headquarters location (zipcode) | String |
company_last_updated | The last update date of the company profile | String |
company_categories_and_keywords | Categories and keywords assigned to the profile | Array of strings |
company_stock_ticker | Stock ticker | Array of strings |
company_is_b2b | Marks if the company sells B2B or B2C products 1 – b2b company 0 – b2c company | Integer |
company_annual_revenue | Annual revenue | Integer |
company_annual_revenue_currency | Annual revenue currency | String |
company_employees_count_change_yearly_percentage | Percentage of employee count change | String |
company_last_funding_round_announced_date | Date of last funding round | String (date) |
company_last_funding_round_amount_raised | Amount of last funding round | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
department | Enriched | Departments derived from the job_title | String |
management_level | Enriched | Management levels identified from the job_title | String |
is_working | Enriched | Current employment marker 1 – Currently employed 0 – Currently unemployed | Boolean |
Data point | Processing | Description | Data type |
---|---|---|---|
education | | Education details | Array of objects |
major | Cleaned | Field of study | String |
title | Cleaned | Educational institution | String |
date_to | Cleaned | Graduation date | Integer |
date_from | Cleaned | Enrolment date | Integer |
institution_url | Cleaned | Institution's profile URL | String |
description | Cleaned | Education description | String |
activities_and_societies | Cleaned | Details about activities and societies | String |
Data point | Description | Data type |
---|---|---|
is_hidden | Marks if the profile has a hidden education/experience collection. 0 – education/experience information was available at the time of profile scraping 1 – education/experience information was not available at the time of profile scraping | Boolean |
Data point | Processing | Description | Data type |
---|---|---|---|
location_raw_address | Cleaned | Associated location | String |
location_country | Cleaned | Parsed country | String |
location_regions | Cleaned | Geographical regions parsed from associated location | Array of strings |
Data point | Processing | Description | Data type |
---|---|---|---|
recommendations | Cleaned | Recommendations from other users | Array of objects |
recommendation | Cleaned | Recommendation text | String |
referee_name | Raw | Referee's name | String |
referee_url | Raw | Referee's profile URL | String |
recommendations_count | Cleaned | Number of received recommendations | Integer |
connections_count | Raw | Number of connections with other users | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
languages | | Language knowledge | Array of objects |
language | Cleaned | Language | String |
proficiency | Cleaned | Language proficiency | String |
order_in_profile | Raw | Record order in the section | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
certifications | | Held certifications | Array of objects |
title | Cleaned | Certificate title | String |
issuer | Cleaned | Certificate issuer | String |
credential_id | Cleaned | Record order in the section | Integer |
certificate_url | Cleaned | Certificate URL | String |
date_from | Cleaned | Issue date | String |
date_to | Cleaned | Expiration date | String |
issuer_url | Cleaned | Issuer profile URL | String |
order_in_profile | Raw | Section record order | Integer |
date_from_year | Cleaned | Issue year | Integer |
date_from_month | Cleaned | Issue month | Integer |
date_to_year | Cleaned | Expiration year | Integer |
date_to_month | Cleaned | Expiration month | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
courses | | Attended courses | Array of objects |
organizer | Cleaned | Course organizer | String |
title | Cleaned | Course title | String |
order_in_profile | Raw | Record order in the section | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
awards | | Held awards | Array of objects |
title | Cleaned | Award | String |
issuer | Cleaned | Award issuer | String |
description | Cleaned | Award description | String |
date | Cleaned | Issue date | String |
order_in_profile | Raw | Section record order | Integer |
date_year | Cleaned | Issue year | Integer |
date_month | Cleaned | Issue month | Integer |
Data point | Processing | Description | Data type |
---|---|---|---|
activity | | Interaction with posts on Professional network | Array of objects |
activity_url | Raw | Post URL | String |
title | Cleaned | Post title | String |
action | Cleaned | Interaction type | String |
order_in_profile | Raw | Section record order | Integer |