Disciplinary Summary

Get Disciplinary Summary

Retrieves an aggregate summary of disciplinary records for an organisation within a specified date range, with optional breakdowns by manager, work location, employing entity, or team.

GET

https://api.employmenthero.com/api/v2/organisations/:organisation_id/disciplinaries/summary

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

Query Parameters

start_datestringrequired

The start date of the reporting period (YYYY-MM-DD). Required.

end_datestringrequired

The end date of the reporting period (YYYY-MM-DD). Required.

group_bystring

One or more dimensions to group by. Accepted values: manager, worklocation, entity, team. Pass a single string for a unified breakdown field, or a comma-separated list for per-dimension breakdownby_* fields.

namestring

Filter results by a name substring across all group dimensions.

name_filtersobject

Per-dimension name filters. Each key is a group_by dimension and its value is a name substring to filter by.

Response Body

Returns a summary of disciplinaries for the organisation within the specified date range. Breakdown fields are only present when the corresponding group_by dimension is requested.

dataobject

totalinteger

The total number of disciplinaries in the specified date range.

breakdownobject[]

Breakdown of disciplinaries by a single group_by dimension. Present when group_by is supplied as a single string value.

breakdown_by_managerobject[]

Breakdown of disciplinaries grouped by manager. Present when group_by includes "manager".

breakdown_by_work_locationobject[]

Breakdown of disciplinaries grouped by work location. Present when group_by includes "work_location".

breakdown_by_entityobject[]

Breakdown of disciplinaries grouped by employing entity. Present when group_by includes "entity".

breakdown_by_teamobject[]

Breakdown of disciplinaries grouped by team. Present when group_by includes "team".

Example

curl -X GET \  "https://api.employmenthero.com/api/v2/organisations/:organisation_id/disciplinaries/summary" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

{  "data": {    "total": 15,    "breakdown": null,    "breakdown_by_manager": [      {        "name": "Jane Smith",        "count": 8      },      {        "name": "Bob Johnson",        "count": 7      }    ],    "breakdown_by_work_location": null,    "breakdown_by_entity": null,    "breakdown_by_team": [      {        "name": "Engineering",        "count": 6      },      {        "name": "Sales",        "count": 9      }    ]  }}