Skip to main content
GET
/
community
/
users
/
list
Community users list with summary stats
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/analytics/community/users/list
import requests

url = "https://{subdomain}.nudj.cx/api/v2/analytics/community/users/list"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://{subdomain}.nudj.cx/api/v2/analytics/community/users/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.nudj.cx/api/v2/analytics/community/users/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://{subdomain}.nudj.cx/api/v2/analytics/community/users/list"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{subdomain}.nudj.cx/api/v2/analytics/community/users/list")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{subdomain}.nudj.cx/api/v2/analytics/community/users/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "summary": {
    "totalUsers": 123,
    "activeUsers": 123,
    "averagePoints": 123,
    "mostRecentUserDate": "<string>"
  },
  "data": {
    "data": [
      {
        "_id": "<string>",
        "createdAt": "<string>",
        "stats": {
          "totalPoints": 123,
          "totalXP": 123,
          "lastActivity": "<string>",
          "totalAchievements": 123,
          "totalChallengesCompleted": 123,
          "totalRewardsEarned": 123,
          "streakInfo": {
            "currentStreak": 123,
            "longestStreak": 123
          }
        },
        "username": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "displayName": "<string>",
        "bio": "<string>",
        "phoneNumber": "<string>",
        "updatedAt": "<string>",
        "lastLoginAt": "<string>",
        "emailVerified": "<string>",
        "roles": [
          "<string>"
        ],
        "role": "<string>",
        "profilePicture": "<string>",
        "profilePictureUrl": "<string>"
      }
    ],
    "pagination": {
      "total": 123,
      "skip": 123,
      "limit": 123
    }
  }
}
{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}
{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}

Query Parameters

communityId
string
skip
integer
default:0
Required range: x >= 0
limit
integer
default:10
Required range: 1 <= x <= 100
sortField
enum<string>
default:lastActivity

Field to sort by. Supports base fields (createdAt, username, email, lastLoginAt, status, role, lastActivity) and computed stats (totalPoints, totalXP, totalAchievements, totalChallengesCompleted, totalRewards, currentStreak, longestStreak).

Available options:
createdAt,
username,
email,
lastLoginAt,
status,
role,
lastActivity,
totalPoints,
totalXP,
totalAchievements,
totalChallengesCompleted,
totalRewards,
currentStreak,
longestStreak
sortDirection
enum<string>
default:desc
Available options:
asc,
desc

Response

Successful response

summary
object
required
data
object
required