Get engagement scores

get

https://api.workleap.com/officevibe/engagement/scores

Get organization engagement scores

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

groupIds

array of uuids

The ids of the groups to filter scores by. If null or empty, it retrieves scores for the all company. Example: ?groupIds=fa3e88b0-a07b-40a2-b118-f157237ddc65&groupIds=57b327b4-d5fe-46db-92f5-2c26ae0c05ad

groupIds

fromDate

date-time

The start date to filter scores by. When granularity is Weekly, automatically set to the previous Sunday. When granularity is Daily and omitted, defaults to 90 days before the end date.

toDate

date-time

The end date to filter scores by. When granularity is Weekly, automatically set to the previous Sunday. When granularity is Daily, defaults to the current day if omitted.

continuationToken

string

The continuation token for pagination to retrieve the next set of results. Use the token from the previous response to continue pagination.

granularity

string

enum

Defaults to Weekly

The score granularity. Weekly (default) returns one score per week; dates are clamped to the previous Sunday. Daily returns one score per day; limited to a 90-day inclusive range.

Allowed:

Responses

401

Unauthorized

403

Forbidden

200OK

400Invalid request