Collecting data from Yext

This guide explains how to collect data from Yext. To learn how to collect data from a different data source, go back to the Available data sources in Adverity overview.

Limitations

Collecting data from Yext comes with the following limitations:

  • You can only collect data from certain dates using Yext. A message will appear if the date range you select is not accepted. Follow the instructions in the error message to change your selection.

    Adverity cannot provide specific dates before you select a date range because the accepted dates are dynamically set by the Yext API.

  • Yext can collect a maximum of 1 million rows per single report. To fetch more data than this, split your fetch into smaller date ranges in the Initial Fetch step of creating a datastream.

Creating a datastream to collect data from Yext

The basics of creating a datastream to collect data from any data source are explained in our guide to Creating a datastream. This guide contains information about the specific steps to create a datastream to fetch data from Yext.

Authorization: Allow Adverity to access Yext

Before creating an authorization to give Adverity access to Yext, perform the following actions:

  1. Get your Yext API key as described in the Yext documentation.

To set up a new authorization to fetch data from Yext, follow these steps:

  1. In the Authorization step of the datastream wizard, click Access Yext using your credentials.

  2. Click Next.

  1. In API key, enter your API key.

Configuration: Choose the data you want to collect from Yext

To choose what data to collect and customize the Yext datastream configuration, follow these steps:

  1. (Optional) Rename your datastream.

  1. In Account IDs, choose how you want to specify the accounts on which to collect data:

    Type in

    Select this option to manually enter the account IDs for the accounts on which you want to collect data.

    If you select this option, in the Accounts field, type in the account IDs for the accounts on which you want to collect data. Enter each account ID on a new line.

    Value table

    Select this option to provide a value table containing the account IDs for the accounts on which you want to collect data.

    If you select this option, in Value table, select the value table containing the account IDs for the accounts on which you want to collect data.

    All account IDs

    Select this option to collect data for all accounts.

  1. In Report type, select the type of data to collect from Yext. The fields you need to configure in the following steps differ according to the report type you select.

  1. In Actors and Activities, select the actors and activities for which to collect data. If you do not select any items in a drop-down list, Adverity collects data for all items in the drop-down list.

  1. In Dimensions and Metrics, change the list of fields that you want to see in your data extract.

  1. In Granularity, select the time unit in which you want to collect data.

  2. In Date filter, select the field that you want to use to define the fetch date range.

What's next?