Contents
On this page
List Reviews - Plugixa Stream
GET /plugixa-stream/v1/series/{id}/reviews
A title’s star summary, one page of its published written reviews, and, signed in, the caller’s own review and whether they may write one.
Public. Signed in, mine, can_review and reason are about the caller. A kids profile gets the stars but no written reviews.
Request
GET https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews?sort=highest
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The title’s id |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
page |
integer |
No | Page, from 1. Defaults to 1. 10 reviews per page. |
sort |
string |
No | newest (the default), highest or lowest. |
Responses
200 OK.
{
"success": true,
"data": {
"enabled": true,
"text": true,
"summary": {
"average": 4.5,
"count": 12,
"stars": {
"5": 8,
"4": 3,
"3": 0,
"2": 1,
"1": 0
}
},
"items": [
{
"id": 31,
"rating": 5,
"body": "Gorgeous, and the ending still gets me.",
"spoiler": false,
"author": "Maya",
"date": "2026-11-12T20:14:03+00:00",
"edited": false,
"mine": false,
"status": "published"
}
],
"total": 7,
"per_page": 10,
"mine": null,
"can_review": true,
"reason": "",
"max_length": 2000
}
}
| Field | Type | Meaning |
|---|---|---|
data.enabled |
boolean |
Reviews are on. When off, data is only {"enabled": false} |
data.text |
boolean |
Written reviews are allowed (not only stars), and the caller is not on a kids profile |
data.summary |
object |
average (one decimal), count, and stars: how many of each, from 5 to 1. Published ratings only |
data.items |
object[] |
Published reviews that have words, fields below |
data.total |
integer |
Published reviews that have words |
data.mine |
object|null |
The caller’s own review, whatever its status |
data.can_review |
boolean |
The caller may rate this title |
data.reason |
string |
Why not: plugixa_stream_login_required, plugixa_stream_reviews_off, plugixa_stream_reviews_kids or plugixa_stream_reviews_watch_first |
data.max_length |
integer |
Longest review, in characters |
data.items[].id |
integer |
The review’s id |
data.items[].rating |
integer |
1 to 5 stars |
data.items[].body |
string |
Plain text, empty for stars only |
data.items[].spoiler |
boolean |
The writer marked it as a spoiler |
data.items[].author |
string |
The profile name, else the first or display name. Never a login or an email |
data.items[].date |
string |
Written, ISO 8601 in UTC |
data.items[].edited |
boolean |
Changed since it was written |
data.items[].mine |
boolean |
Written by the caller’s profile |
data.items[].status |
string |
published; on the caller’s own review, also pending or hidden |
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_stream_not_found |
No published title with that id, or a kids profile may not see it. |
400 |
rest_invalid_param |
sort is not one of the three, or page is below 1. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews?sort=highest"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews?sort=highest');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews?sort=highest');
const { data } = await response.json();
Quick Links
Share