v1

latestOpenAPI 3.0.02026-07-26241258.1 KB
Engagement

Get overview

Return the engagement overview for the entire company.

get/engagement/overview

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'