v1
latestOpenAPI 3.0.22026-07-24154101.1 MBEngage
Retrieve Engagement Overview
get/v2/company/{company_id}/locations/{location_id}/engage_overview
Path parameters
company_idinteger required
Company ID
location_idinteger required
Location ID
Query parameters
datestring required
A date with YYYY-MM-DD format
frequency'week' | 'month'
Length of the engage data set
user_type'employees' | 'managers' | 'assistant_managers'
select user type for engage data
permission_template_idinteger
Permission template to filter by. Only one of this or user_type may be filtered at a time.
Headers
x-api-versionstring
An API version
Example:2022-05-01
7shifts API version
x-company-guidstring uuid
Company GUID
Response
OK