Streams Endpoint
$idstring Required
Must be at least 1 characters long
Must be at most 64 characters long
$schemaconst Required
“https://schema.yext.com/config/streams/streams-endpoint/v2" namestring
The name of the streams endpoint.
streamobject Required
Properties required to configure the data stream for this endpoint.
enum (of string)
The source of data to stream.
Must be one of:
- “content”
- “reviews”
- “reviewsAgg”
array of string
The subset of fields and projections from the source data that should be streamed.
Each item of this array must be:
Filter configuration for knowledgeGraph/content.
array of string
Entity IDs to allow.
Each item of this array must be:
array of string
Entity type IDs to allow.
Each item of this array must be:
array of string
IDs of the saved filters to apply on entities.
Each item of this array must be:
array of string
Publisher IDs to allow.
Each item of this array must be:
object
The transforms that need to be applied to documents before they are produced.
array of string
The option fields that need to be expanded to include the display fields, numeric values, and selected boolean.
Each item of this array must be:
The option field name
array of string
The option fields that need to be replaced with their display names.
Each item of this array must be:
The option field name
object
array of string
The list of additional locales to include in the endpoint.
Each item of this array must be:
Valid BCP-47 locale identifiers.
boolean
Determines whether primary profiles should be excluded from the endpoint.
object
boolean
Determines whether the publisher fields should be transformed to lowercase
fieldIndexesarray of object
The field indexes for this endpoint.
Each item of this array must be:
string Required
The name of the field to be indexed.