PEpeakon
Engagement

Get overview for context

Return the engagement overview for the specified context.

get/engagement/contexts/{contextId}/overview

Request

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

Path parameters

contextIdstring required

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

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 of type 'engagement_overviews'

Changes

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