TagMangoTagMango Docs
Gamification

Get Collective Points For All UsersDeprecated

GET
/api/v2/external/gamification/points/collective

Get collective points for all users based on active subscriptions to mangoes with gamification enabled.

  • Provides total scores obtained by the user for each category of points
  • There are different categories of points assign by the TagMango system - dailyActive, likeOnPost, commentOnPost, messageInRoom, createPost, 10perCourseCompletion, 50perCourseCompletion, 100perCourseCompletion, attendance, signUpThroughAffiliate

:::danger Rate Limiting This endpoint is rate limited to 10 requests per minute. :::

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

mangoes?string

Comma-separated list of mango unique identifiers

users?string

Comma-separated list of user ids

types?string

Comma-separated list of types for filtering points. Could be TagMango system points or custom points.

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

Response Body

application/json

application/json

application/json

curl -X GET "https://api-prod-new.tagmango.com/api/v2/external/gamification/points/collective" \  -H "x-whitelabel-host: string"
[
  {
    "_id": "6659ca9e5f2acb7abfdcd8fd",
    "points": [
      {
        "type": "custom",
        "score": 100
      },
      {
        "type": "attendance",
        "score": 200
      }
    ],
    "totalScore": 300
  }
]
{
  "code": 400,
  "type": "Bad request",
  "statusMessage": "BAD_REQUEST",
  "message": "Invalid request",
  "success": false
}
{
  "code": 401,
  "type": "Unauthorized",
  "statusMessage": "UNAUTHORIZED",
  "message": "Invalid token",
  "success": false
}

Get Collective Points For User GET

Get collective points for an user based on their active subscriptions to mangoes with gamification enabled. - Provides total scores obtained by the user for each category of points - There are different categories of points assign by the TagMango system - dailyActive, likeOnPost, commentOnPost, messageInRoom, createPost, 10perCourseCompletion, 50perCourseCompletion, 100perCourseCompletion, attendance, signUpThroughAffiliate :::info Custom Point Types There could be custom point types generated by other platforms using TagMango API. All of them will be returned under the response. :::

Update Points For Users PATCH

Update points for multiple users at once. - Provides unique identifiers for the points assigned to the users - There are different categories of points assign by the TagMango system - dailyActive, likeOnPost, commentOnPost, messageInRoom, createPost, 10perCourseCompletion, 50perCourseCompletion, 100perCourseCompletion, attendance, signUpThroughAffiliate **Note** - This endpoint can be used to assign points to multiple users at once. - It can also be used to revoke points from users by passing negative score.