API ReferenceRun

Search Channels

Path parameters

ridstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
searchTextstringRequired
previouslySelectedChannelsmap from strings to sets of stringsRequired
refNameFilterset of stringsOptional

If not empty, will filter to channels from the selected DataSourceRefNames.

nextPageTokenstringOptional

Tokens are used with paginated requests to get the next “page” of results from an API, and typically are used as both part of the request and response schema of an endpoint to allow users to stream pages of results.

pageSizeintegerOptional

Defaults to 1000. Will throw if larger than 10000.

Response

This endpoint returns an object.
resultslist of objects
nextPageTokenstringOptional

Tokens are used with paginated requests to get the next “page” of results from an API, and typically are used as both part of the request and response schema of an endpoint to allow users to stream pages of results.