Sign in

v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

post/{client-id}/periodic-streaks/

Path parameters

client-idstring required

Request body

namestring required

Name of the streak

progress_action_keystring required

The action key

period'daily' | 'weekly' | 'monthly' required
timezonestring required

ISO timezone

action_thresholdstring

Number of times a progress_action_key should be performed to increase streak length by 1 in a period

started_atstring

ISO Datetime when the streak will start, if null then streak is started from the day of creation

stopped_atstring

ISO Datetime when the streak will stop being active, if null then streak will never end, unless its archived.

freeze_startstring

ISO Datetime for starting the freeze period for everyone, so that any action performed by user will not result in streak length or any miss will not reset their streak

freeze_untilstring

ISO Datetime for ending the freeze period for everyone, so that any action performed by user will not result in streak length or any miss will not reset their streak

freeze_reasonstring

Optional reason for freezing the streak, only valid if one of freeze_start or freeze_until is provided

profile_group_idsstring[]

List of Livelike profile group ids to which this streak will be applicable, if not provided, streak will be available for all.