v1

latestOpenAPI 3.0.02026-07-26241258.1 KB
Engagement

Get for drivers

Return the engagement details per driver for the entire company.

get/engagement/drivers

Query parameters

filter[employee.segmentIds]integer[]

The array of segment ids that the result should be filtered for. The segment ids should be sent comma-separated and ending with "$contains".

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'

The type of rounds to include data for

observationsboolean

Includes observations array in the returned object, defaults to false.

participationboolean

Includes participation in the returned object, defaults to false.

interval'month' | 'quarter' | 'year' | 'all' | 'recent'

Limit query to a specific date interval, defaults to quarter.

Response

A JSONAPI resource containing an array of 'engagement_drivers' objects