Snapshot Workflow

A Snapshot Workflow describes a workflow question returned by the snapshot score endpoints. Its options use the response scale saved with the snapshot and define the numeric values used to calculate its score. Question text can reflect account or branch overrides.

Example

{
  "id": "NDg2",
  "name": "Interruption frequency",
  "prompt": "On average, how often are you interrupted at work?",
  "options": [
    {
      "label": "Less than once per day",
      "value": 0.5
    },
    {
      "label": "1–3 times per day",
      "value": 2
    },
    {
      "label": "4–6 times per day",
      "value": 5
    },
    {
      "label": "7–10 times per day",
      "value": 8.5
    },
    {
      "label": "More than 10 times per day",
      "value": 12.5
    }
  ],
  "unit": "per day",
  "lower_is_better": true,
  "benchmark": {
    "name": "All companies",
    "p_50": 4.2,
    "p_75": 3.1,
    "p_90": 2.4,
    "year": 2026
  }
}

Properties

Key Type Description
id String The workflow ID.
name String The workflow name.
prompt String The workflow question shown to respondents.
options Array Available response options and the values assigned to them.
unit String Unit used by the option values and calculated workflow score.
lower_is_better Boolean true when lower scores represent better performance; false when higher scores represent better performance. Applies to both scores and benchmarks.
benchmark Object or null The selected or default benchmark for the workflow; null when unavailable.

Option object

Key Type Description
label String Response-option label shown to respondents.
value Number Numeric value used when calculating the workflow score.

Benchmark object

Benchmark scores use the workflow’s unit. Percentiles represent performance: when lower_is_better is true, better performance corresponds to a lower score, so P75 and P90 can be lower than P50. When lower_is_better is false, higher scores represent better performance.

Field Type Description
name String The benchmark segment name.
p_50 Number 50th-percentile benchmark score.
p_75 Number 75th-percentile benchmark score.
p_90 Number 90th-percentile benchmark score.
year Integer Year of the benchmark.