Skip to main content

Analytics

The People analytics figures the app shows, computed over a window of days and cut by month and by department. Nothing here is a stored row: each call measures the records as they stand, so a correction in the app changes the next answer. overview is the dashboard in one call; each metric route returns its monthly series and its department table.

Available on plans that include people analytics.

Plan feature

These endpoints need a plan that includes People analytics (analytics). On a plan without it, requests return 402 with code: plan_upgrade_required and feature naming what an upgrade would add.

Retrieve the analytics overview​

GET/v1/analytics/overview

The dashboard tiles for the window: headcount and its change, joiners and leavers, attrition (regretted leavers counted), absenteeism and the people over the Bradford trigger, overtime hours and cost, leave liability, schedule coverage, time to hire, offer acceptance and goal completion, with the monthly headcount, attrition and absenteeism series. A tile whose records need a plan feature the workspace lacks is null; features says which.

Query parameters​

NameTypeRequiredDescription
fromdateYesFirst day of the window.
todateYesLast day of the window, at most two years after from.
department_idstringNoOnly people in this department, by their current department.

Responses​

StatusMeaning
200The overview.
400The window is missing, malformed or longer than two years.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include People analytics (plan_upgrade_required).
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve one analytics metric​

GET/v1/analytics/{metric}

The metric over the window: series, one point per calendar month; a department table (byDepartment, or byType for leave liability); and totals. absenteeism adds the Bradford factor per person; attrition adds leavers by separation type. hiring needs the recruitment feature and goals the performance feature as well.

Path parameters​

NameTypeRequiredDescription
metricstring (enum)YesWhich figure to measure.

Query parameters​

NameTypeRequiredDescription
fromdateYesFirst day of the window.
todateYesLast day of the window, at most two years after from.
department_idstringNoOnly people in this department, by their current department.

Responses​

StatusMeaning
200The metric.
400The window is missing, malformed or longer than two years.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include People analytics (plan_upgrade_required).
403The key does not carry the required scopes.
404No such metric.
429Rate limit exceeded. See the RateLimit-* headers.