Skip to main content
GET
/
users
/
overview
Get users overview
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/analytics/users/overview \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "userId": "<string>",
      "username": "<string>",
      "email": "<string>",
      "points": 123,
      "createdAt": "<string>",
      "challengesStarted": 123,
      "challengesCompleted": 123,
      "challengesInProgress": 123,
      "achievementsCompleted": 123,
      "profilePictureUrl": "<string>",
      "latestVisit": "<string>",
      "externalUserId": "<string>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Query Parameters

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

Response

Successful response

totalCount
number
required
edges
object[]
required