v1
latestOpenAPI 3.0.02026-07-26241258.1 KBEngagement
Get overview for context
Return the engagement overview for the specified context.
get/engagement/contexts/{contextId}/overview
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.