API Reference

Search Inputs

get
https://apiv3.videoflow.io/ch/{channel_token}/search

Before you begin

  1. Get your Stream Engine channel token. Learn more
  2. Allowlist your domain in the Stream Engine console and optionally allowlist test environments like these docs and Postman. Allowlisting

Query parameter use instructions

  • When you call the API you must send the q or filter_by query parameters, or both.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Text-based search query that searches all the available data

string

Set filters using the format key:value for a single key or key1:value,key2:value,... for multiple values.

The keys and permitted values are: • stream_state: live, vod, scheduled
• name: Populate with the program name
• type: program type
• token: populate with the program token
• include_all_tags
• include_all_metadata
• tags
• metadata: use the format metadata.some_property:some_value

string

Comma-separated list of sorting options.

Allowed values: • stream_state_priority
• start_time
• name
• type

Responses
200

Search results return

400

Bad input parameter. You must provide at least one of q or filter_by

401

Requesting domain not allowlisted. You must allowlist the domain.

404

No channel_token found. Insert a channel token in the placeholder.

Updated 11 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 11 months ago