Tool ID:
aviato_company_bulk_enrichRun this action
Use the TypeScript SDK for one call. Usectx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'aviato_company_bulk_enrich',
{
"lookups": [
{
"id": "id_123",
"name": "Example",
"linkedinID": "https://www.linkedin.com/in/jane-doe"
}
]
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute aviato_company_bulk_enrich --input '{
"lookups": [
{
"id": "id_123",
"name": "Example",
"linkedinID": "https://www.linkedin.com/in/jane-doe"
}
]
}' --json
Example response
The SDK returns this shape atresult.toolResponse.raw. The example values illustrate the response.
{
"data": {
"companies": [
{
"lookupSuccessful": true
}
]
}
}
deepline describe aviato_company_bulk_enrich --json for the latest machine-readable contract.
Input reference
Get enriched details on multiple companies| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.lookups | array | Yes | — | List of company lookups to perform (max 100) |
payload.rescrape | boolean | No | — | Whether or not to automatically rescrape entities with stale data (specified by the maxDataAgeDays parameter). |
payload.maxDataAgeDays | integer | No | — | The threshold / amount of days to consider data stale and trigger an automatic rescrape (if supplied but rescrape parameter is false, expect a bad request error). |
payload.require | array | No | — | List of top-level response fields that must each have a non-empty value on a given lookup. Lookups that don’t satisfy this gate are returned with lookupSuccessful=false and are not billed. |
Output reference
Standard tool result payload.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
result.data | object | Yes | — | Provider response payload. |
result.data.companies | array | Yes | — | — |
result.data.companies[].lookupSuccessful | boolean | Yes | — | — |
result.data.companies[].company | object | No | — | This object represents a company. It includes general information about the company, along with social metrics, web traction metrics, and more. |
result.data.companies[].company.id | string | Yes | — | The Aviato ID of the company |
result.data.companies[].company.name | string | No | — | The name of the company |
result.data.companies[].company.description | string | No | — | Description of the company |
result.data.companies[].company.country | string | No | — | The country of the company (Full country name) |
result.data.companies[].company.region | string | No | — | The region of the company (state/province) |
result.data.companies[].company.locality | string | No | — | The locality of the company (city/town/village) |
result.data.companies[].company.URLs | object | No | — | This object represents different urls that can be associated with any type of entity. (Does not include http prefix) |
result.data.companies[].company.URLs.golden | string | No | — | — |
result.data.companies[].company.URLs.contact | string | No | — | — |
result.data.companies[].company.URLs.twitter | string | No | — | — |
result.data.companies[].company.URLs.website | string | No | — | — |
result.data.companies[].company.URLs.facebook | string | No | — | — |
result.data.companies[].company.URLs.github | string | No | — | — |
result.data.companies[].company.URLs.linkedin | string | No | — | — |
result.data.companies[].company.URLs.pitchbook | string | No | — | — |
result.data.companies[].company.URLs.angelList | string | No | — | — |
result.data.companies[].company.URLs.signalNFX | string | No | — | — |
result.data.companies[].company.URLs.crunchbase | string | No | — | — |
result.data.companies[].company.industryList | array | No | — | The industries the company is associated with. |
result.data.companies[].company.weeklyFacebookChange | number | No | — | The absolute change in the number of Facebook likes the company has over the past week. Format: double. |
result.data.companies[].company.weeklyFacebookPercent | number | No | — | The percentage change in the number of Facebook likes the company has over the past week. This is the change in the number of likes divided by the number of likes at the start of the week. Format: double. |
result.data.companies[].company.monthlyFacebookChange | number | No | — | The absolute change in the number of Facebook likes the company has over the past month. Format: double. |
result.data.companies[].company.monthlyFacebookPercent | number | No | — | The percentage change in the number of Facebook likes the company has over the past month. This is the change in the number of likes divided by the number of likes at the start of the month. Format: double. |
result.data.companies[].company.triMonthlyFacebookChange | number | No | — | The absolute change in the number of Facebook likes the company has over the past 3 months. Format: double. |
result.data.companies[].company.triMonthlyFacebookPercent | number | No | — | The percentage change in the number of Facebook likes the company has over the past 3 months. This is the change in the number of likes divided by the number of likes at the start of the 3 months. Format: double. |
result.data.companies[].company.yearlyFacebookChange | number | No | — | The absolute change in the number of Facebook likes the company has over the past year. Format: double. |
result.data.companies[].company.yearlyFacebookPercent | number | No | — | The percentage change in the number of Facebook likes the company has over the past year. This is the change in the number of likes divided by the number of likes at the start of the year. Format: double. |
result.data.companies[].company.weeklyTwitterChange | number | No | — | The absolute change in the number of Twitter followers the company has over the past week. Format: double. |
result.data.companies[].company.weeklyTwitterPercent | number | No | — | The percentage change in the number of Twitter followers the company has over the past week. This is the change in the number of followers divided by the number of followers at the start of the week. Format: double. |
result.data.companies[].company.monthlyTwitterChange | number | No | — | The absolute change in the number of Twitter followers the company has over the past month. Format: double. |
result.data.companies[].company.monthlyTwitterPercent | number | No | — | The percentage change in the number of Twitter followers the company has over the past month. This is the change in the number of followers divided by the number of followers at the start of the month. Format: double. |
result.data.companies[].company.triMonthlyTwitterChange | number | No | — | The absolute change in the number of Twitter followers the company has over the past 3 months. Format: double. |
result.data.companies[].company.triMonthlyTwitterPercent | number | No | — | The percentage change in the number of Twitter followers the company has over the past 3 months. This is the change in the number of followers divided by the number of followers at the start of the 3 months. Format: double. |
result.data.companies[].company.yearlyTwitterChange | number | No | — | The absolute change in the number of Twitter followers the company has over the past year. Format: double. |
result.data.companies[].company.yearlyTwitterPercent | number | No | — | The percentage change in the number of Twitter followers the company has over the past year. This is the change in the number of followers divided by the number of followers at the start of the year. Format: double. |
result.data.companies[].company.facebookHistorical | record | No | — | This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time. |
result.data.companies[].company.twitterHistorical | record | No | — | This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time. |
result.data.companies[].company.facebookLikes | integer | No | — | The current number of Facebook likes the company has. |
result.data.companies[].company.twitterFollowers | integer | No | — | The current number of Twitter followers the company has. |
result.data.companies[].company.linkedinFollowers | integer | No | — | The current number of LinkedIn followers the company has. |
result.data.companies[].company.monthlyWebTrafficChange | number | No | — | The absolute change in the number of web visitors the company has had over the past month. Format: double. |
result.data.companies[].company.monthlyWebTrafficPercent | number | No | — | The percentage change in the number of web visitors the company has had over the past month. This is the change in the number of visitors divided by the number of visitors at the start of the month. Format: double. |
result.data.companies[].company.triMonthlyWebTrafficChange | number | No | — | The absolute change in the number of web visitors the company has had over the past 3 months. Format: double. |
result.data.companies[].company.triMonthlyWebTrafficPercent | number | No | — | The percentage change in the number of web visitors the company has had over the past 3 months. This is the change in the number of visitors divided by the number of visitors at the start of the 3 months. Format: double. |
result.data.companies[].company.yearlyWebTrafficChange | number | No | — | The absolute change in the number of web visitors the company has had over the past year. Format: double. |
result.data.companies[].company.yearlyWebTrafficPercent | number | No | — | The percentage change in the number of web visitors the company has had over the past year. This is the change in the number of visitors divided by the number of visitors at the start of the year. Format: double. |
This output schema is too large for an inline display. Read the complete live contract with
deepline describe aviato_company_bulk_enrich --json.Deepline cost
- Pricing model:
per_result(per result). - Estimated Deepline credits:
0.14per pricing unit.