minimusdocs
Help center

Streams

Count streams by status

GET/streams/summary/

read Read: looks, changes nothing. Scopes

Counters over every stream the filters select, not just one page, and how many people watch them now. Takes the same filters as the list; page and page_size are ignored.

Query parameters

  • categorystring (uuid)

    Streams filed under this category, as their main one or not.

  • current_serverstring

    The server playing it: the server's id or its name from the install.

  • epgstring

    With a guide channel, without one, picked by the panel, or picked by hand.

    One of: "auto" "manual" "mapped" "unmapped"

  • has_clientsboolean

    Watched by someone now (true), or by nobody (false).

  • import_jobstring (uuid)

    Streams one playlist import added.

  • is_activeboolean

    Turned on (true) or off (false).

  • is_on_demandboolean

    Started only when someone watches (true), or always running (false).

  • providerinteger

    Streams that follow this provider or play from one of its addresses.

  • provider_linkstring

    Streams that follow a provider channel, one the provider no longer lists, or none (with provider: that play from it without following it).

    One of: "gone" "linked" "none"

  • searchstring

    Part of the name, or the stream id.

  • source_linestring

    Streams with a source on this provider line, written server|username, e.g. line.example.com:8080|user1.

  • source_problemstring

    Streams with a source the servers last found down, for this reason.

    One of: "any" "error" "full" "login" "missing" "no_host" "no_media" "other" "refused" "unreachable"

  • statusstring

    What the stream is doing now.

    One of: "error" "offline" "online" "starting"

  • streaming_enginestring

    One of: "ffmpeg" "gstreamer"

  • tidystring

    One group of GET /streams/tidy/.

    One of: "disabled" "ended" "failing" "unlisted" "unwatched"

Response

200 OK

  • totalintegerrequired
  • onlineintegerrequired
  • offlineintegerrequired
  • startingintegerrequired
  • errorintegerrequired
  • viewersintegerrequired

    Connections watching them now.

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means