Step 1: Creating a Content Endpoint
Each Content Endpoint is a unique instance that contains only a specified, pre-processed set of data from upstream systems such as Knowledge Graph or Reviews. This architecture ensures maximum performance and efficiency.
By default, users can create a Content Webhook or perform a Get by ID API request to an Endpoint via the Content API to fetch the data included in that endpoint by ID. However, no fields are indexed for queries on a Content Endpoint. In order to index specific fields for queries (made via API), a user will need to specify these fields as “Indexed”, which will be covered in greater detail later in this guide.
Create a Content Endpoint via the Content Endpoints UI
Content Endpoints can be created directly in the Yext platform using the Content Endpoints UI. To create an endpoint:
- Click Developer in the navigation bar, then click Content Endpoints
- Click + Add Endpoint in the top right corner.
- Enter a Name and ID for your content endpoint.
- Select your Source.
- Knowledge Graph
- Select the relevant filter to determine which entities to include.
- Select the criteria for each filter type — this will be by Entity Type, Saved Filter, or specific set of entities.
- Reviews and Reviews Aggregate
- Select the relevant Publishers.
- Knowledge Graph
- Click Add Fields and select the fields you would like included in the Content Endpoint. Then click Add Fields.
- Click Select Indexed Fields and select the fields you would like to query on based on the list of fields you selected. Then click Add Selected Fields.
- Click Save.
Content Endpoints via Configuration as Code
Content Endpoints can also be configured using Configuration as Code. To do this, you’ll need to add a new Content Endpoint CaC resource. The schema reference of the resource can be found here .
A Content Endpoint Configuration consists of the following properties listed in this reference doc
Once you create and apply this new resource, a Content Endpoint will be instantiated with the ID you provided. It may take some time to refresh the data so that it is available for querying.
Using an App to Add a Content Endpoint
Rather than configuring a Content Endpoint from scratch, you can also simply install any App which contains a Content Endpoint CaC file. You can then modify this CaC file directly to update the configuration of the Content Endpoint, allowing you to add fields to the response, index additional fields, etc.
For example, the Content Endpoints for Reviews app contains configuration for two Content Endpoints, one for individual review data and another for reviews aggregate data (average rating and review count). Once this app is installed, you’ll be able to leverage the Content Endpoints in your account via the Content API or Content Webhooks.