Contents
On this page

Get Dashboard - Plugixa Stream

GET /plugixa-stream/v1/admin/dashboard

The figures of the admin Dashboard: content counts, the next scheduled episodes, and catalogue problems a viewer would notice.

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/dashboard

Responses

200 OK.

{
  "success": true,
  "data": {
    "content": {
      "series": 24,
      "published_series": 24,
      "episodes": 41,
      "published_episodes": 40,
      "scheduled_episodes": 1
    },
    "upcoming": [
      {
        "id": 2827,
        "series_id": 2814,
        "series_title": "Flash Gordon",
        "number": 13,
        "title": "Chapter 13: Rocketing to Earth",
        "publish_at": "2026-11-24 18:00:00",
        "poster": "https://your-site.example/wp-content/uploads/2026/10/flash-gordon-1936-poster-150x150.jpg"
      }
    ],
    "attention": [
      {
        "key": "no_video",
        "count": 0,
        "series": []
      },
      {
        "key": "empty_series",
        "count": 0,
        "series": []
      },
      {
        "key": "no_poster",
        "count": 1,
        "series": [
          {
            "id": 2900,
            "title": "The Last Signal"
          }
        ]
      }
    ],
    "viewing": {
      "viewers": 18,
      "plays": 64,
      "completions": 21,
      "watch_seconds": 30240,
      "top": [],
      "daily": [],
      "funnels": {}
    }
  }
}
Field Type Meaning
data.content object Titles and episodes: all (not trashed) and published; episodes also scheduled
data.upcoming object[] The next 6 scheduled episodes, soonest first. publish_at is site time
data.attention object[] no_video (published or scheduled episodes with no video, counted in episodes), empty_series (published titles with no published episode), no_poster. Each lists the first 5 titles
data.viewing object Watch activity over the last 30 days: distinct viewers, plays, completions, watch_seconds, a daily series (date, viewers), the top titles and per-episode funnels

With Pro, and only for a user with the plugixa_stream_manage_settings capability, data.money adds revenue today, over the last 7 days (week) and 30 days (month), the number of active_vips, and coin unlocks over 30 days.

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/dashboard" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/dashboard');
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/dashboard', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share