loading

Streams Endpoint

$idstring Required

Must be at least 1 characters long

Must be at most 64 characters long

$schemaconst Required

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:

  • “knowledgeGraph”
  • “reviews”
  • “reviewsAgg”
  • “userAcl”
  • “accounts”
  • “userRoles”

array of string

The subset of fields and projections from the source data that should be streamed.

Each item of this array must be:

Type: string

Type: object

Filter configuration for knowledgeGraph.

array of string

Entity type IDs to allow.

Each item of this array must be:

Type: string

array of string

IDs of the saved filters to apply on entities.

Each item of this array must be:

Type: string
Type: object

array of string

Publisher IDs to allow.

Each item of this array must be:

Type: string

object

The transforms that need to be applied to documents before they are produced.

object

A series of JSON Patch transforms to apply on the document.

Each item of this array must be:

Type: object

string

string

string

Type: string
Type: boolean
Type: array
Type: number
Type: object

boolean

Default: false

Indicates whether data from sub-accounts should also be streamed.

object

array of string

The list of additional locales to include in the endpoint.

Each item of this array must be:

Type: string

Valid BCP-47 locale identifiers.

object

A mapping of locales to other locales to use when data in that exact locale is unavailable. Primary field values are always the final fallback.

boolean

Default: false

Determines whether primary profiles should be excluded from the endpoint.

fieldIndexesarray of object

The field indexes for this endpoint.

Each item of this array must be:

Type: object

string Required

The name of the field to be indexed.