Enrichment Functions are used to retrieve data from data enrichment providers for person or company information. Service Credentials should be configured for your data enrichment provider before using the Enrichment functions. See Using Settings for information on connecting your data enrichment provider with Syncari.
Here are some important things to understand about the Enrichment Functions:
- Enrichment Functions are only available in a field pipeline. You'll have to setup enrichment on a field by field basis.
- Enrichment Functions will only retrieve data from your enrichment provider if the incoming field value is empty.
- Syncari stores a full record retrieved from your enrichment provider for 30 days so any subsequent fields that are enriched are pulled from cache and does not consume credits/requests with your enrichment provider.
Enrich Company
The Enrich Company function will retrieve Company data from your data enrichment provider. The enrichment provider will typically require a specific attribute to be used with finding a matching company. For example, Clearbit uses either the company IP Address or Domain to find a matching company record. Use this function in your field pipelines to enrich each field that requires enrichment. The first request for a given company will retrieve all available fields from the enrichment provider and cache the information in Syncari for 30 days. This is done to help prevent excessive usage of your data enrichment service.
Configuration:
1. Enter a label for the node. This will be helpful with identifying the node when viewing your Entity Pipeline.
2. Enter a Description that will explain the criteria configured.
3. Select the Enrichment Provider that will be used with the function.
4. The "Enrich Using" setting will display the attribute(s) that will be used to find a matching company record with the Enrichment Provider. For example, select Domain if you want to find a company record by the Domain.
5. Select the Source Entity that will be enriched.
6. Select Input Field on the Source Entity that will have the value for the option selected in Step 4. For example, if you selected Domain as the "Enrich Using" option, the Input Field should hold the domain for the company.
7. The Enrichment Field option is used to select the field on the Company record that is returned by the Enrichment Provider. This will be the field value that is output by the Enrich Company Function.
Enrich Person
The Enrich Company function will retrieve person data from your data enrichment provider. The attribute typically used when enriching person data is email.
The Enrich Person function will retrieve Person or Contact data from your data enrichment provider. The enrichment provider will typically require a specific attribute to be used with finding a matching person. For example, Clearbit uses a person's Email to find a matching record. Use this function in your field pipelines to enrich each field that requires enrichment. The first request for a given company will retrieve all available fields from the enrichment provider and cache the information in Syncari for 30 days. This is done to help prevent excessive usage of your data enrichment service.
Configuration:
1. Enter a label for the node. This will be helpful with identifying the node when viewing your Entity Pipeline.
2. Enter a Description that will explain the criteria configured.
3. Select the Enrichment Provider that will be used with the function.
4. The "Enrich Using" setting should be set to the attribute that will be used to find a matching person record with the Enrichment Provider.
5. The Source Entity that will be enriched.
6. Select Input Field on the Source Entity that will have the value for the option selected in Step 4. For example, if you selected Email as the "Enrich Using" option, the Input Field you select here should hold the email for the e.
7. The Enrichment Field option is used to select the field on the Company record that is returned by the Enrichment Provider. This will be the field value that is output by the Enrich Company Function.
SimilarWeb Traffic Data
This function enriches your data using the SimilarWeb Traffic Data. This function uses the SimilarWeb Traffic API and can be configured to access Total Traffic, Desktop Traffic and Mobile Web Traffic data from SimilarWeb. The function will return data for a 1 month timeframe.
Configuration:
1. Enter a label for the node. This will be helpful with identifying the node when viewing your Entity Pipeline.
2. Enter a Description that will explain the criteria configured.
3. There are 3 categories to select from:
- Total Traffic
- Desktop Traffic
- Mobile Web Traffic
4. The Traffic Metric options that are displayed are dependent on the Category. Select the Traffic Metric that will be used to enrich your data.
5. Enter a Year and Month in this format, YYYY-MM. Leaving this blank will retrieve data for the current month. You can use the Insert Token option to dynamically set the value to a field value from the record being enriched.
6. Enter a 2 Letter Country Code. Leaving this setting blank will use the "world" option which will set the search to worldwide. You can use the Insert Token option to dynamically set the 2 letter country code value to a field value from the record being enriched.
7. Select the SmilarWeb Credentials that will be used with the function. You will need to configure the SimilarWeb credentials on the Service Credentials page of your Syncari Account.