API Reference

/insights/engagement_heatmap

get
https://apitest.eu.tm.unit4cloud.com/public/insights/engagement_heatmap

Return params:

data

data keys are team_ids (if selected_grouping is teams, it will be country codes if selected_grouping is country). Each key is another hash, which corresponds to the driver id.
For example. Team id 2, has a 81.25 average for driver id 1 in this period, while it has a 75 in the comparison period provided.

company_data

Similar to data but with just driver ids.

Query Params
date

Mandatory - It will be the start from where the results are taken from

date

Mandatory - It will be the end from where the results are taken from

date

(optional) Compare from (start date)

date

(optional )Compare from (end date)

string
Defaults to 'teams'

How do you want to group results (teams, countries, organizations, departments)

team_ids
array of int32s
Defaults to

(Optional) Choose which teams you want to see users from, if no team_ids is passed, it will look in all teams for the client

team_ids
boolean
Defaults to true

(optional) Exclude team leaders from results? Default is true

Responses

Updated almost 6 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated almost 6 years ago