To import data from Yext, choose Data, then Import and choose Yext from the available options as shown below:
On the following screen, enter your Yext API Key as shown below:
Review Options
If the Yext API Key includes access to the Reviews API, the system will import reviews for each location from Yext. The options include the ability to filter based on the presence of keywords in the reviews as follows:
Include keywords: Only reviews containing these keywords will be imported as published.
Exclude keywords: Reviews containing these keywords will be imported as "unpublished"
Enable Profanity Filter: Reviews containing English profanity will be imported as "unpublished"
If you are an Enterprise customer, or a subscriber to our Backgrounding Addon check the "Keep Data In Sync" checkbox to create a recurring job that will repeat this import process automatically.
After clicking next, the import process will continue in the same manner as uploading a file. MetaLocator will load all fields from Yext, including location reviews. Ensure that the provided API key has access to both the Yext locations and reviews API endpoints. We recommend you test that both Yext API URLs return good data from Yext when entered into a browser (replace XXXXX with your Yext API Key)
https://api.yext.com/v2/accounts/me/locations?api_key=XXXXXXXXX&v=20161021
https://api.yext.com/v2/accounts/me/reviews?api_key=XXXXXXXXX&v=20161021
The Import process from this point is covered in our general importing documentation.
Modifying Import Options
If you are an Enterprise customer, or a subscriber to our Backgrounding Addon the process above creates a recurring job that will repeat this import process automatically. The job must be enabled before it will run on regular basis as shown below:
To enable the job, click the toggle under the "Scheduled" column.
To modify job options, click the title under the Job column and modify as shown below:
A parameter called
yext_excludestars
can also include a comma-delimited list of rating levels which should be unpublished. For example
yext_excludestars=1,2
would ensure that all 1 and 2 star reviews were unpublished during import. This and other import filters do not impact existing reviews.
Matching Keys with Yext
Some customers are seeking to augment data already in MetaLocator with additional data from Yext, like hours or reviews. In this case it is important to configure an External Key in MetaLocator which matches a value in Yext. For example, Yext has an ID field which could be added to each location in MetaLocator. Then, during the import, map the Yext ID to the local External Key and choose Update Existing and Insert New. Be sure the key in Yext exactly matches the value in MetaLocator. Yext stores its ID value as a string, not a number, so ensure the key matches completely, including any leading zeros in Yext.