API reference
People analytics
One measure (turnover by type, regretted and early attrition, stability, retention, tenure, absence, span of control, internal moves) across sites, teams and periods, with groups under the minimum size always hidden; saved views, downloads and the minimum group size. Diversity dimensions, and absence or regretted by group, are in the web app only.
7 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
People analytics table#
POST/v1/org/analytics.tableRead
People analytics (Reports → People analytics): one metric across groups (rows) and groups or periods (columns), over `months` months up to to_month (default this month and 12; at most 36), for the whole company or filtered to a team (with the teams below it), location or legal entity. The current month counts as of today; future leavers count nowhere. Metrics: headcount (Headcount: People employed on the last day of the period (today for the current month).) fte (FTE: Full-time equivalents of the people employed on the last day of the period.) joiners (Joiners: Employment periods starting in the period (rehires included; moves inside the company are not joiners).) leavers (Leavers: People whose last day fell in the period.) turnover (Turnover rate: Leavers with their last day in the period ÷ average headcount (the mean, over the months, of the first- and last-day headcount).) voluntary_turnover (Voluntary turnover: Leavers who chose to leave (resignation, retirement) with their last day in the period ÷ average headcount (the mean, over the months, of the first- and last-day headcount).) involuntary_turnover (Involuntary turnover: Leavers whose employment the company or the contract ended (dismissal, redundancy, end of contract) with their last day in the period ÷ average headcount (the mean, over the months, of the first- and last-day headcount).) other_turnover (Other turnover: Leavers who left by mutual agreement, death or another reason with their last day in the period ÷ average headcount (the mean, over the months, of the first- and last-day headcount).) unrecorded_turnover (Turnover, reason not recorded: Leavers with no leaving type recorded (never guessed) with their last day in the period ÷ average headcount (the mean, over the months, of the first- and last-day headcount).) regretted_rate (Regretted attrition: Voluntary leavers HR marked as regretted with their last day in the period ÷ average headcount (the mean, over the months, of the first- and last-day headcount).) regretted_share (Regretted share: Voluntary leavers marked regretted ÷ voluntary leavers with regretted recorded (yes or no).) early_attrition_90 (Early attrition (90 days): Of the people who joined in the period and have been with you 90 days or would have by now, the share whose employment ended within 90 days of their start. Joiners of the last 90 days are too recent to count.) early_attrition_365 (Early attrition (first year): Of the people who joined in the period and started at least a year ago, the share whose employment ended within 365 days of their start. Joiners of the last year are too recent to count.) stability (Stability index: Of the people employed 12 months before the end of the period, the share still employed at its end without a break (a year or more of service).) retention (Retention rate: Of the people employed on the first day of the period, the share still employed on its last day without a break (anywhere in the company).) internal_moves (Internal moves: Transfers and promotions starting in the period ÷ average headcount.) tenure_mean (Average tenure: Mean years since the start of each person's current continuous employment (a move inside the company keeps it), on the last day of the period.) tenure_median (Median tenure: Median years since the start of each person's current continuous employment, on the last day of the period.) absence_rate (Absence rate: Working days of health-related leave (sick and any type marked health) ÷ scheduled working days, while employed. Planned leave is not absence. Never a type, reason or person.) absence_frequency (Absence frequency: Spells of health-related leave starting in the period ÷ the average number of people scheduled to work.) span_mean (Average span of control: Mean direct reports of the people managers in the group on the last day of the period.) span_median (Median span of control: Median direct reports of the people managers in the group on the last day of the period.) managers (People managers: People with at least one direct report on the last day of the period.) manager_share (People managers share: People managers ÷ headcount on the last day of the period.) Dimensions: all (one row, everyone), location (site), unit (top-level teams; unit:2 … unit:8 a level further down, below a single company root), team (each person's own team), legal_entity, title, contract_type, employment_type, manager, tenure_band (< 3 months, 3–12 months, 1–2, 2–5, 5–10, 10+ years), span_band (direct reports: none, 1–3, 4–7, 8–12, 13–20, 21+), gender and age_band (< 25, 25–34, 35–44, 45–54, 55+; from the birthday at the period end) and custom:<key> (a select or yes/no custom field HR marked "Use in people analytics"). Columns may also be period:month, period:quarter or period:year. columns null gives one Total column. Each cell: value (rates as fractions: 0.184 = 18.4 %), numerator and denominator (null in sensitive tables), suppressed and status (too_recent: joiners too recent for early attrition; not_recorded: regretted not recorded for these leavers). Rows and columns hold totals in total/totals. Privacy (always on): a cell of fewer than min_group people (5 by default; a company may raise it to 20 in Settings → Reports) is suppressed; in diversity (gender, age band, custom fields) and absence tables a count under min_group is suppressed too and no numerators are given; when one cell of a row or column is suppressed while its total is shown, the next smallest is suppressed too. API keys, MCP and connected apps never get diversity dimensions, and get absence and regretted only with rows "all", columns null or a period and no filter (hidden: "apps"). Many groups (teams, sites, titles, managers): the 60 largest are shown (top: 5–60) and the rest fold into one row with key "__other__" (label "Other (n groups)"; groups and folded say how many), or top null for every group (at most 500); order "value" puts the highest measure first (hidden groups last, by name; absence keeps the largest groups by people). Suppression is decided on every group, so the Other row and the order never give away a hidden group. At most 40 columns and 500 groups: a larger table is refused (narrow it with a filter or a coarser dimension). Owners, admins and HR; never a custom role. Errors: validation_failed for an unknown metric or dimension, the same dimension twice, more than 36 months, a table too large or a custom field not marked for analytics; not_found for an unknown team, location or legal entity. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).
- Who can call it
- Manage key owner admin hr
- Keys and apps
- No gender, age band or custom-field dimensions; absence and regretted attrition only with rows "all" and no filter (hidden: apps); regretted cells never carry numerators.
- MCP tool
org_analytics_tableon HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
metricstring (enum)One of:
headcount,fte,joiners,leavers,turnover,voluntary_turnover,involuntary_turnover,other_turnover,unrecorded_turnover,regretted_rate,regretted_share,early_attrition_90,early_attrition_365,stability,retention,internal_moves,tenure_mean,tenure_median,absence_rate,absence_frequency,span_mean,span_median,managers,manager_share. Default"turnover".rowsstring1–60 characters. Default
"location".columnsstring | null1–60 characters. Default
"period:quarter".to_monthstringPattern
^\d{4}-(0[1-9]|1[0-2])$.monthsintegerFrom 1 to 36. Default
12.unit_idstring | nulllocation_idstring | nulllegal_entity_idstring | nulltopinteger | nullGroups shown before the rest fold into one "Other" row (5–60; default 60); null: every group (at most 500). Teams, sites, titles, managers and other unordered rows only.
From 5 to 60.
order"size" | "value"size: the largest groups first (default); value: the highest measure first, hidden groups last by name.
Default
"size".
Returns
18 fields
metricstring (enum)requiredOne of:
headcount,fte,joiners,leavers,turnover,voluntary_turnover,involuntary_turnover,other_turnover,unrecorded_turnover,regretted_rate,regretted_share,early_attrition_90,early_attrition_365,stability,retention,internal_moves,tenure_mean,tenure_median,absence_rate,absence_frequency,span_mean,span_median,managers,manager_share.rows_dimstringrequiredcolumns_dimstring | nullrequiredfrom_monthstringrequiredto_monthstringrequiredas_ofstringrequiredmin_groupintegerrequiredsensitivebooleanrequiredA diversity dimension or absence: no numerators or denominators, never a list of people.
hidden"apps" | "time_off_off"requiredapps: not for API keys or AI apps (open Bizisy); time_off_off: absence needs time off.
metric_infoobjectrequired6 fields
groupstringrequiredkind"count" | "decimal" | "rate" | "years" | "ratio"requiredlabelstringrequireddefinitionstringrequiredsourcestringrequirediso_areastringrequired
filtersobjectrequired3 fields
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
columnsobject[]required5 fields
keystringrequiredlabelstringrequiredfromstringrequiredtostringrequirednot_recordedbooleanrequired
rowsobject[]required5 fields
keystringrequiredlabelstringrequirednot_recordedbooleanrequiredcellsobject[]required5 fields
valuenumber | nullrequirednumeratornumber | nullrequireddenominatornumber | nullrequiredsuppressedbooleanrequiredHidden: fewer people than min_group (or a count under it in a diversity or absence table), or hidden with such a cell so it cannot be derived from a total.
status"too_recent" | "not_recorded"required
totalobjectrequired5 fields
valuenumber | nullrequirednumeratornumber | nullrequireddenominatornumber | nullrequiredsuppressedbooleanrequiredHidden: fewer people than min_group (or a count under it in a diversity or absence table), or hidden with such a cell so it cannot be derived from a total.
status"too_recent" | "not_recorded"required
totalsobjectrequired2 fields
cellsobject[]required5 fields
valuenumber | nullrequirednumeratornumber | nullrequireddenominatornumber | nullrequiredsuppressedbooleanrequiredHidden: fewer people than min_group (or a count under it in a diversity or absence table), or hidden with such a cell so it cannot be derived from a total.
status"too_recent" | "not_recorded"required
totalobjectrequired5 fields
valuenumber | nullrequirednumeratornumber | nullrequireddenominatornumber | nullrequiredsuppressedbooleanrequiredHidden: fewer people than min_group (or a count under it in a diversity or absence table), or hidden with such a cell so it cannot be derived from a total.
status"too_recent" | "not_recorded"required
regretted_recordedobject | nullrequired2 fields
recordedintegerrequiredvoluntaryintegerrequired
groupsintegerrequiredRow groups before folding (Not recorded included).
foldedintegerrequiredGroups in the "Other" row (key "__other__"; 0: no such row). It is never drilled.
drillablebooleanrequiredCount cells of this table can list their people (HR in the app): a count metric, no diversity dimension.
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/analytics.table \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"metric": "voluntary_turnover",
"rows": "unit:2",
"columns": "period:quarter",
"to_month": "2026-10",
"months": 24,
"unit_id": null,
"location_id": "l1",
"legal_entity_id": null
}'const res = await fetch('https://api.bizisy.com/v1/org/analytics.table', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"metric": "voluntary_turnover",
"rows": "unit:2",
"columns": "period:quarter",
"to_month": "2026-10",
"months": 24,
"unit_id": null,
"location_id": "l1",
"legal_entity_id": null
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/analytics.table",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"metric": "voluntary_turnover",
"rows": "unit:2",
"columns": "period:quarter",
"to_month": "2026-10",
"months": 24,
"unit_id": None,
"location_id": "l1",
"legal_entity_id": None,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"metric": "voluntary_turnover",
"rows_dim": "location",
"columns_dim": "period:quarter",
"from_month": "2026-07",
"to_month": "2026-10",
"as_of": "2026-10-04",
"min_group": 5,
"sensitive": false,
"hidden": null,
"metric_info": {
"group": "attrition",
"kind": "rate",
"label": "Turnover rate",
"definition": "Leavers with their last day in the period ÷ average headcount.",
"source": "SHRM; CIPD",
"iso_area": "Turnover"
},
"filters": {
"unit": null,
"location": null,
"legal_entity": null
},
"columns": [
{
"key": "2026-Q3",
"label": "Q3 2026",
"from": "2026-07-01",
"to": "2026-09-30",
"not_recorded": false
},
{
"key": "2026-Q4",
"label": "Q4 2026",
"from": "2026-10-01",
"to": "2026-10-04",
"not_recorded": false
}
],
"rows": [
{
"key": "l1",
"label": "Porto",
"not_recorded": false,
"cells": [
{
"value": 0.0412,
"numerator": 7,
"denominator": 170,
"suppressed": false,
"status": null
},
{
"value": 0.0412,
"numerator": 7,
"denominator": 170,
"suppressed": false,
"status": null
}
],
"total": {
"value": 0.0412,
"numerator": 7,
"denominator": 170,
"suppressed": false,
"status": null
}
},
{
"key": "l2",
"label": "Braga",
"not_recorded": false,
"cells": [
{
"value": null,
"numerator": null,
"denominator": null,
"suppressed": true,
"status": null
},
{
"value": null,
"numerator": null,
"denominator": null,
"suppressed": true,
"status": null
}
],
"total": {
"value": null,
"numerator": null,
"denominator": null,
"suppressed": true,
"status": null
}
}
],
"totals": {
"cells": [
{
"value": 0.0412,
"numerator": 7,
"denominator": 170,
"suppressed": false,
"status": null
},
{
"value": 0.0412,
"numerator": 7,
"denominator": 170,
"suppressed": false,
"status": null
}
],
"total": {
"value": 0.0412,
"numerator": 7,
"denominator": 170,
"suppressed": false,
"status": null
}
},
"regretted_recorded": null,
"groups": 2,
"folded": 0,
"drillable": false
}
}Download a people analytics table#
POST/v1/org/analytics.exportWrite
The org_analytics_table table as a file: format csv (UTF-8; delimiter ";" suits Excel in most of Europe) or xlsx (the table, then its definition, source, filters, period and the suppression note). Same input, numbers and suppression as org_analytics_table (built from its result: suppressed cells say "hidden"). Tables with a diversity dimension (gender, age band, custom fields) are refused to API keys, MCP and connected apps (open Bizisy). At most 30 downloads per person a day. Owners, admins and HR; never a custom role. Returns filename, content_type and the file (csv as text in csv, xlsx as base64 in content_base64). Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).
- Who can call it
- Manage key owner admin hr
- Keys and apps
- As the table: diversity tables, and absence or regretted by group, download in the Bizisy app only.
- MCP tool
org_analytics_exporton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
metricstring (enum)One of:
headcount,fte,joiners,leavers,turnover,voluntary_turnover,involuntary_turnover,other_turnover,unrecorded_turnover,regretted_rate,regretted_share,early_attrition_90,early_attrition_365,stability,retention,internal_moves,tenure_mean,tenure_median,absence_rate,absence_frequency,span_mean,span_median,managers,manager_share. Default"turnover".rowsstring1–60 characters. Default
"location".columnsstring | null1–60 characters. Default
"period:quarter".to_monthstringPattern
^\d{4}-(0[1-9]|1[0-2])$.monthsintegerFrom 1 to 36. Default
12.unit_idstring | nulllocation_idstring | nulllegal_entity_idstring | nulltopinteger | nullGroups shown before the rest fold into one "Other" row (5–60; default 60); null: every group (at most 500). Teams, sites, titles, managers and other unordered rows only.
From 5 to 60.
order"size" | "value"size: the largest groups first (default); value: the highest measure first, hidden groups last by name.
Default
"size".format"csv" | "xlsx"Default
"csv".delimiter"," | ";"Default
",".
Returns
filenamestringrequiredcontent_typestringrequiredcsvstring | nullrequiredcontent_base64string | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/analytics.export \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"metric": "headcount",
"rows": "location",
"columns": null,
"format": "xlsx",
"delimiter": ";"
}'const res = await fetch('https://api.bizisy.com/v1/org/analytics.export', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"metric": "headcount",
"rows": "location",
"columns": null,
"format": "xlsx",
"delimiter": ";"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/analytics.export",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"metric": "headcount",
"rows": "location",
"columns": None,
"format": "xlsx",
"delimiter": ";",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"filename": "people-analytics-turnover-2025-11-2026-10.csv",
"content_type": "text/csv; charset=utf-8",
"csv": "Turnover rate\r\n",
"content_base64": null
}
}Saved people analytics views#
POST/v1/org/analytics.views.listRead
The company's saved people analytics views (at most 50), by name: each holds a metric, dimensions, period and filters, never personal data. Open one with org_analytics_table and the same fields. Owners, admins and HR; never a custom role. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules); this read of stored data keeps working while it is off.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_analytics_views_liston HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
viewsobject[]required13 fields
idstringrequirednamestringrequiredmetricstring (enum)requiredOne of:
headcount,fte,joiners,leavers,turnover,voluntary_turnover,involuntary_turnover,other_turnover,unrecorded_turnover,regretted_rate,regretted_share,early_attrition_90,early_attrition_365,stability,retention,internal_moves,tenure_mean,tenure_median,absence_rate,absence_frequency,span_mean,span_median,managers,manager_share.rowsstringrequiredcolumnsstring | nullrequiredmonthsintegerrequiredto_monthstring | nullrequiredunit_idstring | nullrequiredlocation_idstring | nullrequiredlegal_entity_idstring | nullrequiredtopinteger | nullrequiredorder"size" | "value"requiredupdated_atstringrequired
limitintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/analytics.views.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/analytics.views.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/analytics.views.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"views": [
{
"id": "av1",
"name": "Attrition by site",
"metric": "voluntary_turnover",
"rows": "location",
"columns": "period:quarter",
"months": 12,
"to_month": null,
"unit_id": null,
"location_id": null,
"legal_entity_id": null,
"top": 60,
"order": "size",
"updated_at": "2026-10-04T09:00:00.000Z"
}
],
"limit": 50
}
}Save a people analytics view#
POST/v1/org/analytics.views.saveWrite
Saves a people analytics table by name (1–80 characters) so HR can open it again from Reports → People analytics or ⌘K: the metric, rows, columns, months, to_month (null: always up to the current month), filters, top and order, as org_analytics_table takes them (checked the same way). With id, renames or changes that view; a new name must not already be used. At most 50 per company. Owners, admins and HR; never a custom role. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).
- Who can call it
- Manage key owner admin hr
- MCP tool
org_analytics_views_saveon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
metricstring (enum)One of:
headcount,fte,joiners,leavers,turnover,voluntary_turnover,involuntary_turnover,other_turnover,unrecorded_turnover,regretted_rate,regretted_share,early_attrition_90,early_attrition_365,stability,retention,internal_moves,tenure_mean,tenure_median,absence_rate,absence_frequency,span_mean,span_median,managers,manager_share. Default"turnover".rowsstring1–60 characters. Default
"location".columnsstring | null1–60 characters. Default
"period:quarter".monthsintegerFrom 1 to 36. Default
12.unit_idstring | nulllocation_idstring | nulllegal_entity_idstring | nulltopinteger | nullGroups shown before the rest fold into one "Other" row (5–60; default 60); null: every group (at most 500). Teams, sites, titles, managers and other unordered rows only.
From 5 to 60.
order"size" | "value"size: the largest groups first (default); value: the highest measure first, hidden groups last by name.
Default
"size".idstringnamestringrequired1–80 characters.
to_monthstring | nullPattern
^\d{4}-(0[1-9]|1[0-2])$.
Returns
viewobjectrequired13 fields
idstringrequirednamestringrequiredmetricstring (enum)requiredOne of:
headcount,fte,joiners,leavers,turnover,voluntary_turnover,involuntary_turnover,other_turnover,unrecorded_turnover,regretted_rate,regretted_share,early_attrition_90,early_attrition_365,stability,retention,internal_moves,tenure_mean,tenure_median,absence_rate,absence_frequency,span_mean,span_median,managers,manager_share.rowsstringrequiredcolumnsstring | nullrequiredmonthsintegerrequiredto_monthstring | nullrequiredunit_idstring | nullrequiredlocation_idstring | nullrequiredlegal_entity_idstring | nullrequiredtopinteger | nullrequiredorder"size" | "value"requiredupdated_atstringrequired
createdbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/analytics.views.save \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Voluntary attrition by site",
"metric": "voluntary_turnover",
"rows": "location",
"columns": "period:quarter",
"months": 12
}'const res = await fetch('https://api.bizisy.com/v1/org/analytics.views.save', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Voluntary attrition by site",
"metric": "voluntary_turnover",
"rows": "location",
"columns": "period:quarter",
"months": 12
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/analytics.views.save",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Voluntary attrition by site",
"metric": "voluntary_turnover",
"rows": "location",
"columns": "period:quarter",
"months": 12,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"view": {
"id": "av1",
"name": "Attrition by site",
"metric": "voluntary_turnover",
"rows": "location",
"columns": "period:quarter",
"months": 12,
"to_month": null,
"unit_id": null,
"location_id": null,
"legal_entity_id": null,
"top": 60,
"order": "size",
"updated_at": "2026-10-04T09:00:00.000Z"
},
"created": true
}
}Delete a people analytics view#
POST/v1/org/analytics.views.deleteWrite
Deletes a saved people analytics view by id (the numbers are unaffected). Owners, admins and HR; never a custom role. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).
- Who can call it
- Manage key owner admin hr
- MCP tool
org_analytics_views_deleteon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
idstringrequired
Returns
idstringrequireddeletedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/analytics.views.delete \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"id":"av1"}'const res = await fetch('https://api.bizisy.com/v1/org/analytics.views.delete', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"id": "av1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/analytics.views.delete",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "av1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "av1",
"deleted": true
}
}People analytics settings#
POST/v1/org/analytics.settings.getRead
The minimum group size of people analytics and the HR overview breakdowns: cells of fewer people are hidden (5 by default, at most 20; never below 5). Owners, admins and HR; never a custom role. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules); this read of stored data keeps working while it is off.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_analytics_settings_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
min_groupintegerrequiredfloorintegerrequiredceilingintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/analytics.settings.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/analytics.settings.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/analytics.settings.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"min_group": 5,
"floor": 5,
"ceiling": 20
}
}Change the minimum group size#
POST/v1/org/analytics.settings.updateWrite
Sets the minimum group size of people analytics (5–20): a cell of fewer people shows no value. It can be raised, never set below 5. Owners, admins and HR; never a custom role. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).
- Who can call it
- Manage key owner admin hr
- MCP tool
org_analytics_settings_updateon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
min_groupintegerrequiredFrom 5 to 20.
Returns
min_groupintegerrequiredchangedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/analytics.settings.update \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"min_group":8}'const res = await fetch('https://api.bizisy.com/v1/org/analytics.settings.update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"min_group": 8
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/analytics.settings.update",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"min_group": 8,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"min_group": 8,
"changed": true
}
}Something missing or wrong on this page? Write to hello@bizisy.com.