LVS's Search API endpoints enable your application to find Video Clip Metadata using a variety of search criteria.
This functionality is not limited to building user-facing search interfaces, but is useful for any application that needs to select, sequence, and deliver relevant Video Clips, according to end-users’ inputs/preferences and other business rules.
Simple Search vs. Advanced Search
There are two main categories of Search: Simple Search (which searches for Simple Video clip objects -- the metadata that is directly created from JSON metadata ingestion) and Advanced Search (which enables multi-criteria searches for Compound Clips).
Simple Search is useful in content management workflows, where you need to look up Video Clip metadata in a form that closely matches the original ingested JSON metadata format.
Advanced Search is useful for building consumer-facing tools with keyword search and various filters (e.g. topics, dates, etc.)
Grouping and Sorting Video Clip Results
You have the choice to execute searches with with ungrouped results or with results grouped by asset.
Your options for results sorting will differ depending on whether you are using grouped or ungrouped mode.
Ungrouped Results sorting options:
- Relevance (default) - order results according to how closely they match the search term.
- Date Asset Created (oldest or newest)
- Asset Start Date (oldest or newest)
- Asset End Date (oldest or newest)
- Start Time (of Video Clip)
- End Time (of Video Clip).
Grouped Results sorting options:
- Matched Count - Order groups by the number of results within an asset (default)
- Matched Fraction - Order by the ratio of total duration of clips within an asset/asset total duration) -- use this if you want order asset groupings with the highest percentage of matching content at the top of your results.
- Asset Created - Order by the date that the asset was Discovered)
- Asset Start Date - Order by the value in the Asset's "Start Date" field.
- Asset End Date -Order by the value in the Asset's "Start Date" field.
- In an application that searches for 3pt shots from an archive of recorded basketball games for the 2021-2022 season, use grouped Advanced search, sorted by date, to organize clip results by game, with the games ordered chronologically,
- In an education-related research tool that searches for specific topics in recorded lectures, use ungrouped Advanced Search, sorted by relevance, so that the lecture clips that most closely match the user's search appear at the top.
- In a content management workflow where a content administrator needs to routinely review and correct names for AI-identified faces, use the Simple Search grouped to generate lists of "face" Video Clips.
Search API Endpoints
Simple Search operation -
Use this endpoint to search for Simple Video Clip objects within one or multiple discovered video assets.
Grouped search operation
[GET] /v3/search/grouped - Click here for this endpoint's full API specs and testing tool (LVS login required)
Use this endpoint to search for Video Clip objects within one or multiple assets and group the results by asset.
Advanced search operation
GET /v3/search/advanced - Click here for this endpoint's full API specs and testing tool (LVS login required)
Use this endpoint to perform a multi-factor search for Compound Video Clip objects (i.e. intersections between clips of different types) across multiple assets.
Advanced grouped search operation
[GET] /v3/search/advanced/grouped - Click here for this endpoint's full API specs and testing tool (LVS login required)
Use this endpoint to perform a multi-factor search for Compound Video Clip objects and group the results.