PEpeakon
Scores

Get category scores by group

Get category scores according to group.

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

Request

  • Base URL
    https://api.peakon.com/api/v1
  • URL
    https://api.peakon.com/api/v1/scores/contexts/{contextId}/group/{group}
  • Auth
    HTTP bearer

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.

Response

A JSONAPI resource containing an array of 'category_scores' objects

Changes

No recorded changes to this operation across all 1 revision of this API.