Output Response - Company Enrichment API
Detailed information on the output response returned by the Company Enrichment API
Response Data Structure
Here is an example response from the Company Enrichment API:
{
"status": 200,
"id": "google",
"name": "google",
"founded": "1998",
...
}
Full Output Response (click to expand)
{
"status": 200,
"name": "google",
"size": "10001+",
"employee_count": 260979,
"id": "google",
"founded": 1998,
"industry": "internet",
"location": {
"name": "mountain view, california, united states",
"locality": "mountain view",
"region": "california",
"metro": "san francisco, california",
"country": "united states",
"continent": "north america",
"street_address": "1600 amphitheatre parkway",
"address_line_2": null,
"postal_code": "94043",
"geo": null
},
"linkedin_id": "1441",
"linkedin_url": "linkedin.com/company/google",
"facebook_url": "facebook.com/google",
"twitter_url": "twitter.com/google",
"profiles": [
"linkedin.com/company/google",
"linkedin.com/company/1441",
"facebook.com/google",
"twitter.com/google",
"crunchbase.com/organization/google"
],
"website": "google.com",
"ticker": "GOOGL",
"type": "public",
"summary": "google\u2019s mission is to organize the world\u2018s information and make it universally accessible and useful. since our founding in 1998, google has grown by leaps and bounds. from offering search in a single language we now offer dozens of products and services\u2014including various forms of advertising and web applications for all kinds of tasks\u2014in scores of languages. and starting from two computer science students in a university dorm room, we now have thousands of employees and offices around the world. a lot has changed since the first google search engine appeared. but some things haven\u2019t changed: our dedication to our users and our belief in the possibilities of the internet itself.",
"tags": [
"online video",
"artificial intelligence",
"mobile",
"android",
"cloud",
"machine learning",
"virtual reality",
"apps",
"software",
"ads"
],
"headline": null,
"alternative_names": [
"google inc.",
"google, social marketing tools",
"google, inc.",
"google inc",
"google, inc",
"google summer of code",
"google maps",
"google ireland",
"wildfire, a division of google",
"wildfire interactive, inc."
],
"alternative_domains": [
"googlevideo.com",
"google.nl",
"google.pt",
"gkecnapps.cn",
"youtube.com",
"youtu.be",
"youtubeeducation.com",
"gstatic.cn",
"youtubekids.com",
"googleadapis.com"
],
"affiliated_profiles": [
"youtube",
"google-cloud",
"think-with-google",
"google-ads-",
"googleworkspace",
"google-analytics",
"googlemarketingplatform",
"google-ad-manager",
"grow-with-google",
"google-cloud-partners",
"google-for-startups",
"google-small-business",
"x",
"google-partners",
"rework-with-google",
"googleplaydev",
"googleadmob",
"google-user-research.",
"google-news-initiative",
"adometry"
],
"likelihood": 4
}
Response Fields
data.*
data.*
Field Name | Type | Description |
---|---|---|
|
| The matched profile record containing fields from our Company Schema. Any fields in the profile record that do not contain any data will have a |
The data
field includes all information for the record matching the input. The subfields of the data object correspond to the fields in our Company Schema. Any field in the profile record that doesn't have associated information will have a null
value. See the Response Data Structure section above for an example of this data structure.
status
status
Field Name | Type | Description |
---|---|---|
|
|
likelihood
likelihood
Field Name | Type | Description |
---|---|---|
|
| The degree of confidence is represented by the |
Likelihood Score
Every match that the API finds during the enrichment process is assigned a likelihood score, which is an integer between 1 - 10
, representing the confidence that the returned profile is the same as the profile requested. A score of 1
represents a very low confidence level, and a 10
represents the highest degree of confidence. The likelihood score is logarithmic, so a response that returns a likelihood score of 2
will have roughly a 10-30% chance of being the same company as the one requested.
You can use the min_likelihood
parameter (as described below) in your API request to specify a threshold likelihood score that you want the response to meet or exceed.
Controlling What Counts As A Successful Response
You can use these parameters to describe the characteristics that an API response must have to return a 200
:
Parameter Name | Description | Default |
---|---|---|
min_likelihood | The minimum likelihood score a response must have to return a 200 . | 2 |
required | Specifies the fields and data points a response must have to return a 200 . |
Updated 3 months ago