Onboarding Step
{
"id": "integer",
"step": {},
"status": {},
"completion_percentage": "integer",
"results": []
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | Unique integer value identifying this onboarding step |
| step | step | false | read-only | Unique name of the onboarding step |
| status | status | false | read-only | Enum to define the status of the onboarding step |
| completion_percentage | integer | false | read-only | The percentage of completion of the onboarding step (0-100) |
| results | list(Feed or Category) | false | read-only | List of Feed created (for step contents) or Category modified (step categories) |
Enumerated Values
| Property | Value | Description |
|---|---|---|
| step | contents | Identify the onboarding step about contents |
| step | categories | Identify the onboarding step about categories |
| step | appearance | Identify the onboarding step about appearance |
| step | profile | Identify the onboarding step about profile |
| step | invite | Identify the onboarding step about invite |
| step | app | Identify the onboarding step about app |
| status | not_started | The onboarding step is not yet started |
| status | in_progress | The onboarding step is in progress (only for steps contents and categories) |
| status | completed | The onboarding step is completed |
| status | failed | The onboarding step is failed |