Contents
On this page

Get Home Rows - Plugixa Stream

GET /plugixa-stream/v1/admin/rows

The rows of the home screen as configured, in order. What they show is in Get Home.

Needs a user with the plugixa_stream_view capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.

Request

GET https://your-site.example/wp-json/plugixa-stream/v1/admin/rows

Responses

200 OK. data is the list of rows.

{
  "success": true,
  "data": [
    {
      "id": "trending",
      "title": "Trending now",
      "type": "trending",
      "kind": "",
      "series_ids": [],
      "term_id": 0,
      "limit": 12
    },
    {
      "id": "real-blender",
      "title": "Blender Open Movies",
      "type": "manual",
      "kind": "",
      "series_ids": [2681, 2740],
      "term_id": 0,
      "limit": 12
    },
    {
      "id": "anime",
      "title": "Anime",
      "type": "genre",
      "kind": "",
      "series_ids": [],
      "term_id": 12,
      "limit": 12
    }
  ]
}
Field Type Meaning
data[].id string The row’s id
data[].title string Its heading
data[].type string manual, featured, new, genre, trending; with Pro also top_rated
data[].kind string series, movie, or empty for both. Ignored by manual rows
data[].series_ids integer[] The hand-picked titles of a manual row, in order
data[].term_id integer The genre of a genre row
data[].limit integer Most titles shown, 1 to 30

Until rows are saved, the answer is the two starting rows, Trending now (trending) and New releases (new).

Errors

Status Code When
401 / 403 plugixa_stream_forbidden The caller lacks the capability.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/rows" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/rows');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/rows', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share