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>"
  }
]

GET

streaks

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

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

Show child attributes

triggerEvents.platform

enum<string>[]

required

The Nudj platform events that trigger the streak to be extended for a user. For example, challenge completions.

Available options:

achievement-completion,

facebook-comment,

facebook-follow,

facebook-like,

image-analysis-object-detection,

image-analysis-receipt-detection,

instagram-follow,

instagram-like,

instagram-comment,

instagram-share,

instagram-post,

interaction-engage-with-content,

interaction-external-link,

interaction-image-upload,

interaction-spot-object,

platform-comment-on-post,

platform-complete-achievement,

platform-generative-action,

platform-like-post,

platform-play-game,

platform-validate-event,

question-multiple-choice,

question-open-ended,

question-rate-your-experience,

question-secret-access-code,

question-select-date,

question-select-from-images,

question-select-value-in-range,

question-select-from-list,

question-closed-ended,

question-vote,

spotify-follow,

spotify-listen,

spotify-save,

tiktok-follow,

tiktok-watch,

tiktok-post,

youtube-like,

youtube-comment,

youtube-subscribe,

action-completion,

skip-action,

42-school,

api-auth-link,

api-token-link,

apple,

asgardeo,

atlassian,

auth0,

authentik,

azure-ad-b2c,

azure-ad,

azure-devops,

battlenet,

beyondidentity,

box,

boxyhq-saml,

bungie,

click-up,

cognito,

coinbase,

descope,

discord,

dribbble,

dropbox,

duende-identity-server6,

email,

eveonline,

facebook,

faceit,

foursquare,

freshbooks,

fusionauth,

github,

gitlab,

google,

hubspot,

identity-server4,

instagram,

kakao,

keycloak,

line,

linkedin,

mailchimp,

mailru,

mastodon,

mattermost,

medium,

naver,

netlify,

notion,

okta,

onelogin,

organisation-oidc,

osso,

osu,

passage,

patreon,

pinterest,

pipedrive,

reddit,

salesforce,

slack,

spotify,

strava,

tiktok,

todoist,

trakt,

twitch,

twitter,

united-effects,

vk,

wikimedia,

wordpress,

workos,

yandex,

youtube,

zitadel,

zoho,

zoom,

blog-comment,

blog-like,

blog-share,

blog-view,

challenge-started,

challenge-completion,

challenge-unlock,

community-visit,

parental-approval-requested,

parental-approval-approved,

parental-approval-rejected,

custom,

game-started,

game-completed,

leaderboard-finish,

invite-admin-user,

points-credit,

points-spend,

post-comment,

post-like,

post-view,

reward-redemption,

reward-allocation-purchase,

reward-giveaway-winner,

reward-claim,

reward-distribution,

manual-distribution,

referral-link-used,

shop-purchase,

share-challenge-details,

share-challenge-results,

share-community,

share-reward,

share-post,

share-profile,

share-anything,

streak-extended,

profile-picture-added,

bio-added,

variable-captured,

xp-gained,

xp-total,

xp-leaderboard-topper

triggerEvents.custom

string[]

required

The custom events that trigger the streak to be extended for a user.

userState

object

required

Show child attributes

userState.currentStreak

number

required

The current length for this streak

userState.isCurrentDayComplete

boolean

required

Whether the user has already extended their streak today

communityId

string | null

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

Get my reward asset by id Update my info

⌘I

Achievements

Action Participations

Actions

Auth Config

Campaigns

Challenge Groups

Challenges

Comments

Communities

Events

Feature Flags

Languages

Leaderboards

Legal Policies

Me

Posts

Rewards

Tags

Themes

Third Party Config

Variables

Get my streak progress

Authorizations

Query Parameters

Response