> ## Documentation Index
> Fetch the complete documentation index at: https://v3.captaindata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Sales Navigator Metrics

> Retrieve a search URL for employee metrics starting from a company ID.

This API action allows you to generate a Sales Navigator search URL for employees, starting from a given company ID. It provides various metrics related to the leads from the specified company.

### Inputs

<ParamField path="sales_navigator_company_id" type="string" required={true} primary={true}>
  The unique identifier for the company in Sales Navigator.
</ParamField>

### Parameters

Refine your search using the following parameters:

<ParamField path="employeesSearchKeywords" type="string">
  Add keywords to the employee search.
</ParamField>

<ParamField path="employeesTitle" type="string">
  Add a title to the employee search using Boolean keywords.
</ParamField>

<ParamField path="geo" type="string">
  Filter employees by geography using LinkedIn location codes.
</ParamField>

<ParamField path="seniority" type="string">
  Filter employees by seniority level using Sales Navigator codes.
</ParamField>

<ParamField path="function" type="string">
  Filter employees by department using Sales Navigator codes.
</ParamField>

<ParamField path="excludeCRMContacts" type="boolean" default={false}>
  Exclude CRM contacts from the search.
</ParamField>

<ParamField path="excludeSavedLeads" type="boolean" default={false}>
  Exclude saved leads from the search.
</ParamField>

<ParamField path="excludeViewedLeads" type="boolean" default={false}>
  Exclude leads that have been viewed recently.
</ParamField>

### Output Fields

The action returns the following fields:

<ResponseField>
  <Expandable title="properties">
    <ResponseField name="company_name" type="string">
      The name of the company
    </ResponseField>

    <ResponseField name="leads_mentionned_in_news" type="integer">
      Number of leads mentioned in news
    </ResponseField>

    <ResponseField name="leads_past_colleague" type="integer">
      Number of leads who are past colleagues
    </ResponseField>

    <ResponseField name="leads_posted_recently" type="integer">
      Number of leads who posted recently
    </ResponseField>

    <ResponseField name="leads_teamlink_your_executives" type="integer">
      Number of leads with team link to your executives
    </ResponseField>

    <ResponseField name="leads_viewed_profile_recently" type="integer">
      Number of leads who viewed your profile recently
    </ResponseField>

    <ResponseField name="leads_with_common_experience" type="integer">
      Number of leads with common experience
    </ResponseField>

    <ResponseField name="leads_following_your_company" type="integer">
      Number of leads following your company
    </ResponseField>

    <ResponseField name="linkedin_company_url" type="string">
      The LinkedIn company URL
    </ResponseField>

    <ResponseField name="new_leads" type="integer">
      Number of new leads
    </ResponseField>

    <ResponseField name="sales_navigator_company_id" type="string">
      The Sales Navigator company ID
    </ResponseField>

    <ResponseField name="sales_navigator_company_url" type="string">
      The Sales Navigator company URL
    </ResponseField>

    <ResponseField name="sales_navigator_profile_search_url" type="string">
      The Sales Navigator profile search URL
    </ResponseField>

    <ResponseField name="total_leads" type="integer">
      Total number of leads
    </ResponseField>
  </Expandable>
</ResponseField>

Below is the JSON schema for the output fields:

<Accordion title="Show JSON Output Schema">
  ```json
  {
      "company_name": "string",
      "leads_mentionned_in_news": "integer",
      "leads_past_colleague": "integer",
      "leads_posted_recently": "integer",
      "leads_teamlink_your_executives": "integer",
      "leads_viewed_profile_recently": "integer",
      "leads_with_common_experience": "integer",
      "leads_following_your_company": "integer",
      "linkedin_company_url": "string",
      "new_leads": "integer",
      "sales_navigator_company_id": "string",
      "sales_navigator_company_url": "string",
      "sales_navigator_profile_search_url": "string",
      "total_leads": "integer"
  }
  ```
</Accordion>

### Specificities

<Info>
  Ensure that the Sales Navigator numbers for functions, geography, and
  seniority are correctly formatted and separated by commas without spaces for
  multiple entries.
</Info>