v1

latestOpenAPI 3.0.02026-07-26241258.1 KB
Scores

Get question scores by group

Get question scores according to group.

get/scores/contexts/{contextId}/questions/group/{group}

Path parameters

contextIdstring required

A company or segment context id. Param is a string formatted as company_[companyId] or segment_[segmentId].

group'engagement' | 'diversity_inclusion' | 'health_wellbeing' | 'transformation_change' | 'onboarding' | 'exit' | 'covid19' | 'other' | 'environmental_social_governance' | 'ancc_magnet_nursing_excellence' | 'values' required

The name of the category group.

Query parameters

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.

includeSubcategoriesboolean

Include scores for questions in subcategories.

Response

A JSONAPI resource containing an array of 'engagement_questions' objects