---
title: "Get segments groups"
method: GET
path: "/engagement/contexts/{contextId}/segments/groups"
tags: ["Engagement"]
---

# Get segments groups

`GET /engagement/contexts/{contextId}/segments/groups`

Return the number of segments with engagement data grouped by attribute.

## Path parameters

- `contextId` string, required

## Query parameters

- `filter[employee.segmentIds]` integer[]
- `filter[question.driver]` 'accomplishment' | 'autonomy' | 'collaboration' | 'communication' | 'engagement' | 'environment' | 'free_opinions' | 'goal_setting' | 'growth' | 'management_support' | 'meaningful_work' | 'organisational_fit' | 'peer_relationship' | 'recognition' | 'reward' | 'reward_recognition' | 'strategy' | 'workload'
- `filter[question.subdriver]` 'accomplishment' | 'advocacy' | 'alignment' | 'belief' | 'belief_in_action' | 'belief_in_strategy' | 'burnout' | 'career_development' | 'career_path' | 'challenging' | 'collaboration' | 'communication' | 'cross_collaboration' | 'customer_satisfaction' | 'demand_for_skills' | 'distributive_fairness' | 'effective_systems' | 'effective_tools' | 'efficacy' | 'equality' | 'equipment' | 'expectancy_theory' | 'fair_rewards' | 'feel_accomplished' | 'feeling_energised' | 'finding_focus' | 'focus' | 'friendly' | 'goals' | 'health' | 'how' | 'how_to_work' | 'impact' | 'inclusive_culture' | 'informal' | 'interactional_fairness' | 'job_fit' | 'job_security' | 'job_significance' | 'known_expectations' | 'leadership_honesty' | 'learning' | 'learning_from_mistakes' | 'learning_resources' | 'loyalty' | 'manageable_work' | 'manager' | 'manager_support' | 'meaningful_work' | 'meeting_customer_needs' | 'mentoring' | 'mission' | 'multiple_perspectives' | 'one_to_ones' | 'openness' | 'opinions_matter' | 'opportunity' | 'performance' | 'pride_in_work' | 'procedural_fairness' | 'professional_growth' | 'recognition' | 'response' | 'safe_sharing_environment' | 'satisfaction' | 'self_confidence' | 'strategy' | 'support' | 'team' | 'timely_communication' | 'trying_new_things' | 'values' | 'values_fit' | 'when' | 'where' | 'willing_to_help' | 'work_environment' | 'work_meaning'
- `filter[question.valueId]` integer
- `filter[round.type]` 'automatic' | 'test'

## Response `200`

A [JSONAPI resource](http://jsonapi.org/format/#document-resource-objects) of type 'engagement_segment_groups'

- object
  - `data` EngagementSegmentGroups
    - `type` string
    - `id` string
    - `attributes` object
      - `segmentCount` integer
      - `negativeCount` integer
      - `positiveCount` integer
    - `relationships` object
      - `attribute` object
        - `data` ResourceIdentifier
          - `type` string
          - `id` string
  - `included` ResourceIdentifier[] — An array of included JSONAPI resources
    - `type` string
    - `id` string

---

[API](https://skmtc.net/peakon/apis/peakon-api.md) · [All operations](https://skmtc.net/peakon/apis/peakon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peakon/peakon-api/revisions/cd09bd8acab5/schema)