Audience Segments

Features

Features or feature IDs are a way to codify a set of properties. For example, the property "currently a software engineer" could be codified by the feature ID 123 or the property "worked at Microsoft" by the feature ID 456, and both can be used to search for people that are currently software engineers or that worked at Microsoft.

Features are categorized by segments and by types within each segment. Currently, the supported segments are persons and companies. Each segment contains features for searching (people or companies) by different criteria.

Up to 530 feature IDs can be returned.

total counts returned feature rows. Feature-name search syntax is distinct from the numeric ID-expression syntax used by segment preview/query. For companies employee_size, code is required (A through I); search alone is insufficient. expand_search applies to type=job_title. For concat_features=t, a returned row may have null id/mod/name/explanation and feature_concat="123|456" (illustrative IDs), usable as an OR query.

get/segment-features/{segment}

Request

Base URL
https://api.mixrank.com/v2/json/YOUR_API_KEY
Auth
none declared

Path parameters

segment'persons' | 'companies' required

Segment of feature IDs to retrieve. Supported values: <code>persons</code> and <code>companies</code>.

Query parameters

Each segment supports different types of features. Persons Feature types to search people by: <ul> <li><code>company</code>: company names.</li> <li><code>job_title</code>: job titles.</li> <li><code>industry</code>: industry names.</li> <li><code>country</code>: location country.</li> <li><code>company_type</code>: company type.</li> <li><code>language_prof</code>: language proficiency.</li> <li><code>job_title_tag</code>: job title tags, such as seniority, job function, etc.</li> <li><code>linkedin_school</code>: linkedin schools.</li> </ul> Companies Feature types to search companies by: <ul> <li><code>industry</code>: industry names.</li> <li><code>company_type</code>: company type.</li> <li><code>country</code>: country of headquarters.</li> <li><code>employee_size</code>: number of employees.</li> </ul>

limitinteger

Maximum number of feature rows returned.

searchstring

Term used for looking up feature IDs. Case insensitive and cannot be longer than 8000 characters.

codestring

Parameter used for looking up feature IDs by encoded values. Codes of type <code>company_type</code>: <ul> <li><code>G</code>: Government Agency</li> <li><code>S</code>: Partnership</li> <li><code>P</code>: Privately Held</li> <li><code>D</code>: Educational</li> <li><code>E</code>: Self Employed</li> <li><code>N</code>: Non Profit</li> <li><code>C</code>: Public Company</li> <li><code>O</code>: Self Owned</li> </ul> Codes of type <code>employee_size</code>: <ul> <li><code>A</code>: Self-employed</li> <li><code>B</code>: 2--10 employees</li> <li><code>C</code>: 11--50 employees</li> <li><code>D</code>: 51--200 employees</li> <li><code>E</code>: 201--500 employees</li> <li><code>F</code>: 501--1,000 employees</li> <li><code>G</code>: 1,001--5,000 employees</li> <li><code>H</code>: 5,001--10,000 employees</li> <li><code>I</code>: 10,001+ employees</li> </ul>

company_idinteger

MixRank company ID; supported for type=company.

urlstring

Parameter used for looking up feature IDs by a specific domain of a company or school. It only works for features of type <code>company</code> or <code>linkedin_school</code>.

org_idinteger

LinkedIn company ID; supported for type=company.

linkedin_urlstring

Parameter used for looking up feature IDs by a specific LinkedIn URL of a company or school. It only works for features of type <code>company</code> or <code>linkedin_school</code>.

expand_search't' | 'f'

This parameter is used to expand job title feature search to include fuzzier matches. It only works for features of type <code>job_title</code>.

concat_features't' | 'f'

This parameter concatenates expand_search job title feature results in a single string separated by vertical bars (<code>|</code>), ready to be used as a final query. The <code>feature_concat</code> response field is populated with the result.

tag_typestring

This parameter is used to filter the job_title_tag type. It only works for features of type <code>job_title_tag</code>. <ul> <li><code>job_seniority</code></li> <li><code>job_function</code></li> <li><code>job_employment_type</code></li> <li><code>job_academic_qualification</code></li> </ul>

modifiersstring

Example:present,ever

Comma-separated modifiers. Features support modifiers and they allow for finer filters. For example, searching for people who previously worked at a company, the <code>past</code> modifier is used. Also this parameter is used for search language proficiency levels as <code>Native or bilingual proficiency</code>.

If this parameter is not passed, all features matching the <code>search</code> term are returned. The modifiers supported by each feature type within each segment are: Persons <ul> <li><code>company</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>job_title</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>industry</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>country</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>company_type</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>language_prof</code>: <code>NP: No proficiency</code>, <code>EP: Elementary proficiency</code>, <code>LWP: Limited working proficiency</code>, <code>PWP: Professional working proficiency</code>, <code>FPP: Full professional proficiency</code>, <code>NBP: Native or bilingual proficiency</code>. <li><code>job_title_tag</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>linkedin_school</code>: Only <code>ever</code> linkedin_school features are returned.</li> </li> </ul> Companies <ul> <li><code>industry</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>company_type</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>country</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> <li><code>employee_size</code>: <code>past</code>, <code>present</code>, <code>ever</code>.</li> </ul>

Response

Successful response.

Example response

{
  "total": 1,
  "results": [
    {
      "id": 3096224825841206,
      "mod": "present",
      "name": "Microsoft",
      "explanation": "Currently works at \"Microsoft\"."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.