Get the onboarding preference.

GET

/api/users/me/onboarding

const url = 'https://api.tradr.cloud/api/users/me/onboarding';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.tradr.cloud/api/users/me/onboarding

Authed. Whether the user has started, skipped or finished the guided walkthrough, when they first used the calculator, and which contextual coach marks they have already dismissed. Preference only — this does not report checklist progress, which is derived from the user’s accounts and positions and so cannot disagree with their real data. Never null: a user who has expressed no preference reads as pending with an empty coach-mark list.

Responses

200

The resolved onboarding preference.

application/json

object

calculatorFirstUsedAt

Absent until the calculator has been used.

string format: date-time

coachMarksSeen

Surface keys already dismissed, as a set.

Array<string>

sidebarPinned

Whether the nav rail is pinned to its expanded state. Absent until the user (or the client’s one-time seed) has expressed a preference.

boolean

status

pending not started, active running, skipped dismissed (recoverable — set it back to start again), done completed.

string

Allowed values: pending active skipped done

Example

{
  "coachMarksSeen": [],
  "status": "pending"
}

401

Authentication required.