Skip to main content
GET
/
me
/
streaks
Get my streak progress
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/me/streaks \
  --header 'x-api-token: <api-key>'
[
  {
    "id": "<string>",
    "organisationId": "<string>",
    "isEnabled": true,
    "triggerEvents": {
      "platform": [
        "achievement-completion"
      ],
      "custom": [
        "<string>"
      ]
    },
    "userState": {
      "currentStreak": 123,
      "isCurrentDayComplete": true
    },
    "communityId": "<string>"
  }
]

Authorizations

​
x-api-token
string
header
required

Query Parameters

​
communityId
string

Response

Successful response

​
id
string
required

The id of the streak config

​
organisationId
string
required

The id of the organisation this streak config belongs to

​
isEnabled
boolean
required

Whether the streak is enabled and users can start and extend streaks.

​
triggerEvents
object
required
​
userState
object
required
​
communityId
string | null

The id of the community this streak config belongs to. No community means this is an organisation level streak config.