loading

list

To simplify the user experience of using the CLI to monitor streams, we have a list command which lists all the streams in an account. By default, the 10 most recently updated streams will be displayed.

Note: The stream-config resource is read-only, which means stream-config resources will not be visible by default in Admin Console (though they will be included in CLI pulls). In order to view a read-only resource, a user will need to check a flag in the Admin Console settings, or use this command in the CLI.

Usage

yext streams list [flags]

Flags

Flag Description
-d, --destination string Filter to only streams for a specific destination. Allowed values: streamsapi, answers, pages, listings
-h, --help Help for resources apply
-l, --limit int Number of streams to display. Defaults to 10.
-p, --pageToken string If a response to a previous request contained the nextPageToken field, pass that field’s value as the pageToken parameter to retrieve the next page of data.


This command will return a table with the following information about each stream:

  • Stream ID
  • Source
  • Filter
  • Destination
  • Last Update Time
  • Output Record Count (Current)

refresh list

Lists refresh jobs filtered by the given flags. By default, the 10 most recent refresh jobs will be displayed.

Usage

yext streams refresh list [flags]

Flags

Flag Description
-d, --destination string Filter to only streams for a specific destination. Allowed values: streamsapi, answers, pages, listings
-h, --help Help for resources apply
-l, --limit int Number of refresh jobs to display. (default 10)
-p, --pageToken string If a response to a previous request contained the nextPageToken field, pass that field’s value as the pageToken parameter to retrieve the next page of data.
-s, --stream The ID of the specific stream for which you want refresh jobs listed.


This command will return a table with information about the refresh job:

  • Refresh Job ID
  • Stream ID
  • Stream Destination
  • Start Time
  • Status
  • Output Records Produced
  • Errors

refresh status

Print the status of a refresh job.

It is valid not to specify a refresh-job-id and only supply a streamId using the -s flag; in this case, the command will print the status of the most recent refresh job for the specified stream.

Usage

yext streams refresh status [<refresh-job-id>] [flags]

Arguments

Argument Description
refresh-job-id The id of the refresh job. You can find this by running yext streams refresh list to view existing refreshes in your account.


Flags

Flag Description
-h, --help Help for resources pull
-s, --stream string The id of the stream. You can find this by running the streams list command.


view records

Displays the most recent input or output records of a stream. Will only display a maximum of 10 records.

Usage

yext streams view records <streamId> [flags]

Flags

Flag Description
-c, --color Colorize the output. (default true)
-d, --display strings Parts of the record to display. Allowed values: key, body, headers. (default [key,body])
-f, --follow maintain connection and receive new records until cancelled
-h, --help Help for resources diff
-l, --limit int Number of records to display. 10 is the maximum number of records which will be displayed.
-t, --type string Whether records displayed should be the “input” records (before any projections or transformations) or the “output” records which are produced by the Stream. Allowed values: input, output. (default “output”)