getProjectsPeopleUtilization
Analyze user and project utilization data, including billable and non-billable time, availability, and metrics. Customize reports with filters, sorting, and grouping for detailed insights.
Instructions
Return the user utilization data. This endpoint provides detailed information about user utilization, including billable and non-billable time, availability, and various utilization metrics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| IncludeCompletedTasks | No | include completed tasks | |
| companyIds | No | filter by company ids | |
| endDate | No | filter by end date | |
| fields[users] | No | specific user fields to include | |
| fields[utilizations] | No | specific utilization fields to include | |
| groupBy | No | group by | |
| include | No | include additional data | |
| includeArchivedProjects | No | include archived projects | |
| includeClients | No | include client users | |
| includeCollaborators | No | include collaborators | |
| includeTotals | No | adds report summary to response | |
| includeUtilizations | No | adds report rows for individual entities | |
| isCustomDateRange | No | determine if the query is for a custom date range | |
| isReportDownload | No | generate a report document | |
| jobRoleIds | No | filter by jobrole ids | |
| legacyResponse | No | return response without summary and its legacy body structure | |
| orderBy | No | sort by | |
| orderMode | No | group by | |
| page | No | page number | |
| pageSize | No | number of items in a page | |
| projectIds | No | filter by project ids | |
| reportFormat | No | define the format of the report | |
| searchTerm | No | filter by user first or last name | |
| selectedColumns | No | customise the report by selecting columns to be displayed | |
| skipCounts | No | skip doing counts on a list API endpoint for performance reasons | |
| sort | No | sort by (deprecated, use orderBy) | |
| sortOrder | No | order mode | |
| startDate | No | filter by start date | |
| teamIds | No | filter by team ids | |
| userIds | No | filter by userIds | |
| zoom | No | determine the type of zoom filter used to display on the report |
Input Schema (JSON Schema)
{
"properties": {
"IncludeCompletedTasks": {
"description": "include completed tasks",
"type": "boolean"
},
"companyIds": {
"description": "filter by company ids",
"items": {
"type": "integer"
},
"type": "array"
},
"endDate": {
"description": "filter by end date",
"type": "string"
},
"fields[users]": {
"description": "specific user fields to include",
"items": {
"type": "string"
},
"type": "array"
},
"fields[utilizations]": {
"description": "specific utilization fields to include",
"items": {
"type": "string"
},
"type": "array"
},
"groupBy": {
"description": "group by",
"enum": [
"day",
"week",
"month"
],
"type": "string"
},
"include": {
"description": "include additional data",
"items": {
"type": "string"
},
"type": "array"
},
"includeArchivedProjects": {
"description": "include archived projects",
"type": "boolean"
},
"includeClients": {
"description": "include client users",
"type": "boolean"
},
"includeCollaborators": {
"description": "include collaborators",
"type": "boolean"
},
"includeTotals": {
"description": "adds report summary to response",
"type": "boolean"
},
"includeUtilizations": {
"description": "adds report rows for individual entities",
"type": "boolean"
},
"isCustomDateRange": {
"description": "determine if the query is for a custom date range",
"type": "boolean"
},
"isReportDownload": {
"description": "generate a report document",
"type": "boolean"
},
"jobRoleIds": {
"description": "filter by jobrole ids",
"items": {
"type": "integer"
},
"type": "array"
},
"legacyResponse": {
"description": "return response without summary and its legacy body structure",
"type": "boolean"
},
"orderBy": {
"description": "sort by",
"enum": [
"name",
"percentutilization",
"percentestimatedutilization",
"availableminutes",
"unavailableminutes",
"loggedminutes",
"billableminutes",
"unbillableminutes",
"companycount",
"achieved",
"target",
"allocatedutilization",
"totalworkingminutes",
"availableutilization",
"unavailableutilization"
],
"type": "string"
},
"orderMode": {
"description": "group by",
"enum": [
"weekly",
"monthly"
],
"type": "string"
},
"page": {
"description": "page number",
"type": "integer"
},
"pageSize": {
"description": "number of items in a page",
"type": "integer"
},
"projectIds": {
"description": "filter by project ids",
"items": {
"type": "integer"
},
"type": "array"
},
"reportFormat": {
"description": "define the format of the report",
"enum": [
"pdf"
],
"type": "string"
},
"searchTerm": {
"description": "filter by user first or last name",
"type": "string"
},
"selectedColumns": {
"description": "customise the report by selecting columns to be displayed",
"items": {
"type": "string"
},
"type": "array"
},
"skipCounts": {
"description": "skip doing counts on a list API endpoint for performance reasons",
"type": "boolean"
},
"sort": {
"description": "sort by (deprecated, use orderBy)",
"enum": [
"name",
"percentutilization",
"percentestimatedutilization",
"availableminutes",
"unavailableminutes",
"loggedminutes",
"billableminutes",
"unbillableminutes",
"billableutilization",
"nonbillableutilization"
],
"type": "string"
},
"sortOrder": {
"description": "order mode",
"enum": [
"asc",
"desc"
],
"type": "string"
},
"startDate": {
"description": "filter by start date",
"type": "string"
},
"teamIds": {
"description": "filter by team ids",
"items": {
"type": "integer"
},
"type": "array"
},
"userIds": {
"description": "filter by userIds",
"items": {
"type": "integer"
},
"type": "array"
},
"zoom": {
"description": "determine the type of zoom filter used to display on the report",
"enum": [
"week",
"month",
"last3months",
"quarterbyweek",
"quarterbymonth"
],
"type": "string"
}
},
"type": "object"
}