Skip to main content
GET
/
achievements
/
stats
/
participants
Achievement participants list
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/analytics/achievements/stats/participants
{
  "data": {
    "data": [
      {
        "userId": "<string>",
        "displayName": "<string>",
        "email": "jsmith@example.com",
        "createdAt": "2023-11-07T05:31:56Z",
        "progressPercentage": 50,
        "xpAwarded": 1,
        "pointsAwarded": 1,
        "rewardsCount": 1,
        "rewardNames": [
          "<string>"
        ],
        "completedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "total": 123,
      "skip": 123,
      "limit": 123
    }
  },
  "summary": {
    "totalCompletions": 123,
    "totalInProgress": 123
  }
}

Query Parameters

​
achievementId
string
required
Pattern: ^[a-f\d]{24}$
​
skip
integer
default:0
Required range: x >= 0
​
limit
integer
default:10
Required range: 1 <= x <= 100
​
search
string
​
sortField
enum<string>
default:completedAt
Available options:
completedAt,
createdAt,
displayName,
email
​
sortDirection
enum<string>
default:desc
Available options:
asc,
desc
​
status
enum<string>
Available options:
completed,
in-progress
​
startDate
string<date-time>
​
endDate
string<date-time>

Response

Successful response

​
data
object
required
​
summary
object
required