Becoming You Labs Partner API
  • Documentation
  • API Reference
Information
Assessment
    Get published assessment schemaget
Sessions
    Create an assessment sessionpostGet session statusgetRecord answerspostComplete and score a sessionpostGet session resultsget
Subjects
    Get latest results for one of your usersget
Schemas
powered by Zuplo
Becoming You Labs Partner API
Becoming You Labs Partner API

Schemas


Error

​object · required

AnswerResponse

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · type="likert" · requires: value
type = object · type="single_choice" · requires: choiceId
type = object · type="free_text" · requires: text
Properties for Variant 1:
type
​string · enum · required
Enum values:
likert
value
​integer · min: 1 · max: 7 · required

AnswerItem

questionId
​integer · int32 · required
​AnswerResponse · required

Question

One question as exposed to partners. Everything needed to render the item yourself in the headless flow.
id
​integer · required

Use this as questionId when submitting answers.

prompt
​string · required
type
​string · enum · required
Enum values:
likert
single_choice
free_text
group
​string · required

Sequencing group, mirroring the Values Bridge life context (ideal or current). Empty string when the question is ungrouped.

position
​integer · required

Zero-based position within the assessment.

required
​boolean · required
​object

Present for likert questions that pin an explicit scale.

​object[]

Present for single_choice questions.

​object

Scoring metadata for Values Bridge questions. Informational only — scoring happens server-side on completion.

AssessmentSchema

product
​string
assessmentId
​integer
version
​integer
​Question[]

CreateSessionRequest

Every field is optional, but the body itself is not: send at least `{}`.
subject
​object | null
mode
​string · enum
Enum values:
headless
hosted
Default: headless
redirectUrl
​string · uri

Where to send the end user after a hosted session completes. Required when mode is "hosted", and must be an http(s) URL.

​object

Accepted and validated but not currently persisted or echoed back. Do not rely on retrieving it later.

HeadlessSession

sessionId
​string · uuid
mode
​string · enum
Enum values:
headless
​object
​AssessmentSchema

HostedSession

sessionId
​string · uuid
mode
​string · enum
Enum values:
hosted
hostedUrl
​string · uri

SessionStatus

sessionId
​string · uuid
product
​string
status
​string · enum
Enum values:
in_progress
completed
createdAt
​string · date-time
completedAt
​string | null · date-time

SubmitAnswersRequest

​AnswerItem[] · minItems: 1 · required

CompleteRequest

​AnswerItem[]

ValueTier

string | null · enum
Enum values:
core
moderate
peripheral

Tier a value falls into for the given life context.

ValuesBridgeResults

Scored Values Bridge results. Per-value `authenticityGapScaled` is a signed percentage of the rating span in −100…+100 (positive = the value is lived less than desired); totals (`totalAuthenticityGapScaled`, `totalConflictScoreScaled`, `totalHarmonyScoreScaled`) and pairing `scaledScore`s are 0–100. `values` is ordered by `idealDisplayRank` ascending, `pairings` by `scaledScore` descending. Numeric fields are null when a value or pairing produced no score.
​object · required
​object[] · required
​object[] · required

NullableValuesBridgeResults

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: overall, values, pairings
type = null
Properties for Variant 1:
Scored Values Bridge results. Per-value `authenticityGapScaled` is a signed percentage of the rating span in −100…+100 (positive = the value is lived less than desired); totals (`totalAuthenticityGapScaled`, `totalConflictScoreScaled`, `totalHarmonyScoreScaled`) and pairing `scaledScore`s are 0–100. `values` is ordered by `idealDisplayRank` ascending, `pairings` by `scaledScore` descending. Numeric fields are null when a value or pairing produced no score.
ValuesBridgeResults
​object · required
​object[] · required
​object[] · required

CompletedSession

sessionId
​string · uuid
status
​string · enum
Enum values:
completed
​NullableValuesBridgeResults

Scored results, or null when the session has not been scored yet.

SessionResults

Only returned once the session is scored; an unscored session is a `404 not_found`.
sessionId
​string · uuid
​ValuesBridgeResults

Scored Values Bridge results. Per-value authenticityGapScaled is a signed percentage of the rating span in −100…+100 (positive = the value is lived less than desired); totals (totalAuthenticityGapScaled, totalConflictScoreScaled, totalHarmonyScoreScaled) and pairing scaledScores are 0–100. values is ordered by idealDisplayRank ascending, pairings by scaledScore descending. Numeric fields are null when a value or pairing produced no score.

SubjectResults

​object
sessionId
​string · uuid
completedAt
​string | null · date-time
​NullableValuesBridgeResults

Scored results, or null when the session has not been scored yet.

AssessmentCompletedEvent

id
​string · uuid · required

Unique event id; identical across retries for dedupe.

type
​string · enum · required
Enum values:
assessment.completed
createdAt
​string · date-time · required
​object · required
On this page
  • Error
  • AnswerResponse
  • AnswerItem
  • Question
  • AssessmentSchema
  • CreateSessionRequest
  • HeadlessSession
  • HostedSession
  • SessionStatus
  • SubmitAnswersRequest
  • CompleteRequest
  • ValueTier
  • ValuesBridgeResults
  • NullableValuesBridgeResults
  • CompletedSession
  • SessionResults
  • SubjectResults
  • AssessmentCompletedEvent