Contents
On this page
List Related Videos - Plugixa Video
GET /pvx/v1/videos/{id}/related
List suggestions for what to watch after a video: hand-picked ones first, then the next episodes of a series, then the closest matches.
Public. Needs Plugixa Video Pro with the Related videos app on in Plugixa Video -> App manager; with it off, this route answers 404.
Note. Matches are scored on shared tags, categories, channel and series, then views and freshness, and the list is cached for an hour per video (cleared when the video is saved). Only published videos are suggested; a site with nothing to match on gets its most viewed videos.
Request
GET https://your-site.example/wp-json/pvx/v1/videos/838/related?limit=6
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The video’s id |
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
limit |
integer |
12 |
How many videos, 1 to 24. |
This endpoint is not paged and takes no other list parameters.
Responses
200 OK. data is a list of videos, best first.
{
"success": true,
"data": [
{
"id": 840,
"title": "Faroe Islands by Ferry",
"excerpt": "A week around Iceland on Route 1, from Reykjavik to the glacier lagoons of the south coast.",
"source": "mp4",
"type": "video",
"poster": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg",
"poster_srcset": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg 1024w, https://your-site.example/wp-content/uploads/2026/11/ring-road-300x169.jpg 300w",
"poster_width": 1024,
"poster_height": 576,
"duration": 920,
"access": "free",
"price": 0.0,
"channel_id": 692,
"channel": "Far Places",
"views": 880,
"likes": 21,
"categories": [14],
"permalink": "https://your-site.example/video/faroe-islands-by-ferry/",
"date": "2026-11-10T08:00:00+00:00",
"status": "publish",
"coming_soon": false
}
]
}
| Field | Type | Meaning |
|---|---|---|
data[] |
object |
Videos in the public shape of List Videos |
There is no meta. Videos hand-picked in the video’s related field always come first, in their order.
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_video_not_found |
No video with that id, or one that is not published, unlisted or scheduled. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/pvx/v1/videos/838/related?limit=6"
<?php
$query = http_build_query([
'limit' => 6,
]);
$ch = curl_init('https://your-site.example/wp-json/pvx/v1/videos/838/related?' . $query);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const query = new URLSearchParams({ limit: "6" });
const response = await fetch(`https://your-site.example/wp-json/pvx/v1/videos/838/related?${query}`);
const { data } = await response.json();
Quick Links
Share