Project User Stats

curl "https://api.streampixel.io/pixelStripeApi/projects/userStats/[PROJECT_ID]?userId=[YOUR_USER_ID]&apikey=[YOUR_API_KEY]"

const axios = require('axios');

const { data } = await axios.get(
  `https://api.streampixel.io/pixelStripeApi/projects/userStats/${projectId}`,
  {
    params: {
      userId: '[YOUR_USER_ID]',
      apikey: '[YOUR_API_KEY]',
    },
  }
);

console.log(`Live: ${data.liveUser}, Queue: ${data.queueUser}`);

import requests

response = requests.get(
    f"https://api.streampixel.io/pixelStripeApi/projects/userStats/{project_id}",
    params={
        "userId": "[YOUR_USER_ID]",
        "apikey": "[YOUR_API_KEY]",
    },
)

print(response.json())

package main

import (
  "fmt"
  "io"
  "net/http"
  "net/url"
)

func main() {
  projectID := "[PROJECT_ID]"
  base := "https://api.streampixel.io/pixelStripeApi/projects/userStats/" + projectID

  q := url.Values{}
  q.Set("userId", "[YOUR_USER_ID]")
  q.Set("apikey", "[YOUR_API_KEY]")

  resp, err := http.Get(base + "?" + q.Encode())
  if err != nil {
    fmt.Println("Request failed:", err)
    return
  }
  defer resp.Body.Close()

  body, _ := io.ReadAll(resp.Body)
  fmt.Println("Response:", string(body))
}

import okhttp3.*;

public class ProjectUserStats {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        HttpUrl url = HttpUrl.parse("https://api.streampixel.io/pixelStripeApi/projects/userStats/[PROJECT_ID]")
            .newBuilder()
            .addQueryParameter("userId", "[YOUR_USER_ID]")
            .addQueryParameter("apikey", "[YOUR_API_KEY]")
            .build();

        Request request = new Request.Builder().url(url).get().build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

{
  "liveUser": 7,
  "queueUser": 2
}

{
  "message": "projectId, userId and apikey are required"
}

{
  "message": "Invalid User"
}

{
  "message": "Unauthorized: Invalid API Key"
}

{
  "message": "Access denied"
}

{
  "message": "Project not found"
}

{
  "message": "Internal server error"
}

GET

pixelStripeApi

projects

userStats

{projectId}

curl "https://api.streampixel.io/pixelStripeApi/projects/userStats/[PROJECT_ID]?userId=[YOUR_USER_ID]&apikey=[YOUR_API_KEY]"

const axios = require('axios');

const { data } = await axios.get(
  `https://api.streampixel.io/pixelStripeApi/projects/userStats/${projectId}`,
  {
    params: {
      userId: '[YOUR_USER_ID]',
      apikey: '[YOUR_API_KEY]',
    },
  }
);

console.log(`Live: ${data.liveUser}, Queue: ${data.queueUser}`);

import requests

response = requests.get(
    f"https://api.streampixel.io/pixelStripeApi/projects/userStats/{project_id}",
    params={
        "userId": "[YOUR_USER_ID]",
        "apikey": "[YOUR_API_KEY]",
    },
)

print(response.json())

package main

import (
  "fmt"
  "io"
  "net/http"
  "net/url"
)

func main() {
  projectID := "[PROJECT_ID]"
  base := "https://api.streampixel.io/pixelStripeApi/projects/userStats/" + projectID

  q := url.Values{}
  q.Set("userId", "[YOUR_USER_ID]")
  q.Set("apikey", "[YOUR_API_KEY]")

  resp, err := http.Get(base + "?" + q.Encode())
  if err != nil {
    fmt.Println("Request failed:", err)
    return
  }
  defer resp.Body.Close()

  body, _ := io.ReadAll(resp.Body)
  fmt.Println("Response:", string(body))
}

import okhttp3.*;

public class ProjectUserStats {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        HttpUrl url = HttpUrl.parse("https://api.streampixel.io/pixelStripeApi/projects/userStats/[PROJECT_ID]")
            .newBuilder()
            .addQueryParameter("userId", "[YOUR_USER_ID]")
            .addQueryParameter("apikey", "[YOUR_API_KEY]")
            .build();

        Request request = new Request.Builder().url(url).get().build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

{
  "liveUser": 7,
  "queueUser": 2
}

{
  "message": "projectId, userId and apikey are required"
}

{
  "message": "Invalid User"
}

{
  "message": "Unauthorized: Invalid API Key"
}

{
  "message": "Access denied"
}

{
  "message": "Project not found"
}

{
  "message": "Internal server error"
}

Return real-time counts of live users (active streaming sessions) and queued users (waiting for a worker) for a single project. Use this to power live status indicators, capacity dashboards, and autoscaling triggers without pulling the full session list.

Live and queue state is read from Redis, so this endpoint is fast enough to poll on a short interval. A few seconds between polls is plenty — the counts update in near real time.

Typical workflow

Authenticate

Pass userId and apikey as query parameters. Both are required.

Request the counts

Call GET /projects/userStats/{projectId} for the project you want to inspect.

Render or react

Use liveUser and queueUser in your dashboard, or compare against thresholds to trigger alerts.

Prerequisites

Requirement	Where to get it
User ID	Finding your IDs
Project ID	Finding your IDs
API Key	API authentication

Unlike most Streampixel endpoints (which take apiKey in the JSON body), this is a GET request — the API key is passed as the apikey query parameter. Treat the URL as sensitive: prefer server-side calls and avoid logging it in plain text.

Path parameters

string

required

The ID of the project to fetch live and queue user counts for.

Query parameters

string

required

The ID of the account that owns the project. Must match the project’s owner.

string

required

Your Streampixel API key. Note the all-lowercase casing — this parameter is apikey, not apiKey.

Response

number

Number of users currently in an active streaming session for this project. Sessions in Terminated or Terminating state are excluded.

number

Number of users waiting in the project’s queue for a worker to become available.

curl "https://api.streampixel.io/pixelStripeApi/projects/userStats/[PROJECT_ID]?userId=[YOUR_USER_ID]&apikey=[YOUR_API_KEY]"

const axios = require('axios');

const { data } = await axios.get(
  `https://api.streampixel.io/pixelStripeApi/projects/userStats/${projectId}`,
  {
    params: {
      userId: '[YOUR_USER_ID]',
      apikey: '[YOUR_API_KEY]',
    },
  }
);

console.log(`Live: ${data.liveUser}, Queue: ${data.queueUser}`);

import requests

response = requests.get(
    f"https://api.streampixel.io/pixelStripeApi/projects/userStats/{project_id}",
    params={
        "userId": "[YOUR_USER_ID]",
        "apikey": "[YOUR_API_KEY]",
    },
)

print(response.json())

package main

import (
  "fmt"
  "io"
  "net/http"
  "net/url"
)

func main() {
  projectID := "[PROJECT_ID]"
  base := "https://api.streampixel.io/pixelStripeApi/projects/userStats/" + projectID

  q := url.Values{}
  q.Set("userId", "[YOUR_USER_ID]")
  q.Set("apikey", "[YOUR_API_KEY]")

  resp, err := http.Get(base + "?" + q.Encode())
  if err != nil {
    fmt.Println("Request failed:", err)
    return
  }
  defer resp.Body.Close()

  body, _ := io.ReadAll(resp.Body)
  fmt.Println("Response:", string(body))
}

import okhttp3.*;

public class ProjectUserStats {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        HttpUrl url = HttpUrl.parse("https://api.streampixel.io/pixelStripeApi/projects/userStats/[PROJECT_ID]")
            .newBuilder()
            .addQueryParameter("userId", "[YOUR_USER_ID]")
            .addQueryParameter("apikey", "[YOUR_API_KEY]")
            .build();

        Request request = new Request.Builder().url(url).get().build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

{
  "liveUser": 7,
  "queueUser": 2
}

{
  "message": "projectId, userId and apikey are required"
}

{
  "message": "Invalid User"
}

{
  "message": "Unauthorized: Invalid API Key"
}

{
  "message": "Access denied"
}

{
  "message": "Project not found"
}

{
  "message": "Internal server error"
}

Error reference

Status	Message	Cause
`400`	`projectId, userId and apikey are required`	One or more required parameters were omitted.
`401`	`Invalid User`	The supplied `userId` doesn’t match any account.
`401`	`Unauthorized: Invalid API Key`	The `apikey` doesn’t match the user’s current key.
`403`	`Access denied`	The project exists but isn’t owned by `userId`.
`404`	`Project not found`	No project with the supplied `projectId`.
`500`	`Internal server error`	Unexpected failure. Retry; if it persists, contact support.

Polling pattern

For a live dashboard, poll on a short interval and stop the timer when the page is hidden. This keeps the UI responsive without hammering the API.

Node.js / Browser

async function fetchStats(projectId, userId, apikey) {
  const url = new URL(
    `https://api.streampixel.io/pixelStripeApi/projects/userStats/${projectId}`
  );
  url.searchParams.set('userId', userId);
  url.searchParams.set('apikey', apikey);

  const res = await fetch(url);
  if (!res.ok) throw new Error(`stats failed: ${res.status}`);
  return res.json();
}

let timer = setInterval(async () => {
  try {
    const { liveUser, queueUser } = await fetchStats(
      '[PROJECT_ID]',
      '[YOUR_USER_ID]',
      '[YOUR_API_KEY]'
    );
    render({ liveUser, queueUser });
  } catch (err) {
    console.error(err);
  }
}, 5000);

If you only need an aggregate view across many projects, batch your polling on the server and push updates to clients over WebSocket or SSE — this is far cheaper than every browser tab polling directly.

List projects

Enumerate every project so you can fetch stats for each.

Rate limits & errors

Limits per endpoint and the standard error response format.

List Projects Overview

Getting started

Endpoints

Webhooks

Typical workflow

Prerequisites

Path parameters

Query parameters

Response

Error reference

Polling pattern

Next

List projects

Rate limits & errors

​Typical workflow

​Prerequisites

​Path parameters

​Query parameters

​Response

​Error reference

​Polling pattern

​Next

List projects

Rate limits & errors

Typical workflow

Prerequisites

Path parameters

Query parameters

Response

Error reference

Polling pattern

Next