Output Response - Autocomplete API

Response Data Structure

Abridged Response Data Structure

Here is an example response from the Autocomplete API when querying for field = "company" and text = "goog":

{
  "data": [
     {
      "name": "google",
      "count": 248006,
      "meta": {
        "website": "google.com",
        "location_name": "mountain view, california, united states",
        "industry": "internet",
        "id": "google"
      }
    },
   ...
  ],
  "fields": [
    "job_company_name",
    "experience.company.name"
  ],
  "status": 200
}

Full Example Response

Full Output Response (click to expand)

{
  "data": [
    {
      "name": "google",
      "count": 248006,
      "meta": {
        "website": "google.com",
        "location_name": "mountain view, california, united states",
        "industry": "internet",
        "id": "google"
      }
    },
    {
      "name": "google adsense",
      "count": 2468,
      "meta": {
        "website": null,
        "location_name": "mountain view, california, united states",
        "industry": "consumer services",
        "id": "google-adsense"
      }
    },
    {
      "name": "google operations center",
      "count": 1716,
      "meta": {
        "website": "googleoperationscenter.com",
        "location_name": null,
        "industry": "internet",
        "id": "googleoperationscenter"
      }
    },
    {
      "name": "google developers",
      "count": 1638,
      "meta": {
        "website": null,
        "location_name": "mountain view, california, united states",
        "industry": "internet",
        "id": "googledevelopers"
      }
    },
    {
      "name": "google ads",
      "count": 1001,
      "meta": {
        "website": "g.com",
        "location_name": "mountain view, california, united states",
        "industry": "internet",
        "id": "goog-ads"
      }
    },
    {
      "name": "google via adecco",
      "count": 437,
      "meta": {
        "website": null,
        "location_name": "austin, texas, united states",
        "industry": "staffing and recruiting",
        "id": "google-via-adecco"
      }
    },
    {
      "name": "google summer of code",
      "count": 428,
      "meta": {
        "website": "summerofcode.withgoogle.com",
        "location_name": null,
        "industry": "computer software",
        "id": "google-summer-of-code-2019"
      }
    },
    {
      "name": "google local guides",
      "count": 287,
      "meta": {
        "website": "localguidesconnect.com",
        "location_name": "mountain view, california, united states",
        "industry": "internet",
        "id": "googlelocalguides"
      }
    },
    {
      "name": "google adwords certified",
      "count": 286,
      "meta": {
        "website": "google-adwords-certified.com",
        "location_name": null,
        "industry": "marketing and advertising",
        "id": "googleadwordscertified"
      }
    },
    {
      "name": "google india",
      "count": 260,
      "meta": {
        "website": null,
        "location_name": null,
        "industry": "internet",
        "id": "google-india1"
      }
    }
  ],
  "fields": [
    "job_company_name",
    "experience.company.name"
  ],
  "status": 200
}

Response Fields

`fields`

Type	Description
`Array (String)`	The list of fields in the Person Schema that the Autocomplete API has returned suggestions for. It determines these based on the value that you used for the `field` input parameter.

See the field input parameter description for the mapping between Autocomplete API fields and Person Schema fields.

`data`

Type	Description
`Array (Object)`	The list of suggestions that the Autocomplete API has returned. It sorts results in descending order based on `data.count`. The `size` input parameter determines the size of the list.

`data.count`

Type	Description
`Integer`	The number of records in our Person Dataset (resume slice) for this Autocomplete suggestion.

`data.name`

Type	Description
`String`	The plain text Autocomplete API suggestion. For example, company name, school name, location name, title and so forth. The prefix of this field will match the value of the `text` input parameter.

`data.meta.*`

Type	Description
`Object`	A set of additional fields that the API returns for each result in the data array. The metadata fields depend on the `field` input parameter.

The Autocomplete API returns some additional metadata fields along with autocomplete suggestion to provide additional context about it. The specific metadata fields that it returns depends on which field was set in the input parameters.

The tables below describe the metadata fields that the API returns for each input field parameter.

Metadata Fields for Company

The metadata fields that the API returns when field = "company" in the input parameters:

Metadata Field	Type	Description	Example
`industry`	`Enum (String)`	The most relevant industry for this company.	`internet`
`location_name`	`String`	The name of the most relevant location for this company.	`san francisco, california, united states`
`website`	`String`	The website associated with this company.	`peopledatalabs.com`
`id`	`String`	The PDL ID for this company.	`peopledatalabs`

Metadata Fields for Country

The metadata fields that the API returns when field = "country" in the input parameters:

Metadata Field	Type	Description	Example
None	--	--	--

Metadata Fields for Industry

The metadata fields that the API returns when field = "industry" in the input parameters:

Metadata Field	Type	Description	Example
None	--	--	--

Metadata Fields for Location

The metadata fields that the API returns when field = "location" in the input parameters:

Metadata Field	Type	Description	Example
`country`	`Enum (String)`	The country of this location.	`united states`
`locality`	`String`	The locality of this location.	`san francisco`
`region`	`String`	The region of this location.	`california`

Metadata Fields for Major

The metadata fields that the API returns when field = "major" in the input parameters:

Metadata Field	Type	Description	Example
None	--	--	--

Metadata Fields for Region

The metadata fields that the API returns when field = "region" in the input parameters:

Metadata Field	Type	Description	Example
None	--	--	--

Metadata Fields for Role

The metadata fields that the API returns when field = "role" in the input parameters:

Metadata Field	Type	Description	Example
None	--	--	--

Metadata Fields for Sub_Role

The metadata fields that the API returns when field = "sub_role" in the input parameters:

Metadata Field	Type	Description	Example
`role`	`Enum (String)`	The role associated with this subrole (see Mapping Title Subroles to Roles.)	`engineering`

Metadata Fields for School

The metadata fields that the API returns when field = "school" in the input parameters:

Metadata Field	Type	Description	Example
`location_name`	`String`	The name of the most relevant location for this school.	`eugene, oregon, united states`
`website`	`String`	The website associated with this school.	`business.uoregon.edu`
`id`	`String`	The PDL ID for this school.	`a56df063-4562-4e59-bc4c-68b33c14df1e`

Metadata Fields for Skill

The metadata fields that the API returns when field = "skill" in the input parameters:

Metadata Field	Type	Description	Example
None	--	--	--

Metadata Fields for Title

The metadata fields that the API returns when field = "title" in the input parameters:

Metadata Field	Type	Description	Example
None	--	--	--

`status`

Type	Description
`Integer`	The API response code.