getProjectsReportingUserTaskCompletion
Retrieve detailed task completion statistics for a specific user within defined date ranges, project filters, and custom report formats.
Instructions
Returns task completions for a given user. Retrieve a person record and its task completion stats.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| companyIds | No | company ids | |
| endDate | No | end date for task completion report | |
| excludeContacts | No | exclude contact types, returning only account and collaborator. | |
| excludeIds | No | exclude certain user ids | |
| excludeProjectIds | No | exclude people assigned to certain project id | |
| fieldsCompanies | No | Query parameter: fields[companies] | |
| fieldsPeople | No | Query parameter: fields[people] | |
| fieldsPerson | No | Query parameter: fields[person] | |
| fieldsProjectPermissions | No | Query parameter: fields[ProjectPermissions] | |
| fieldsTeams | No | Query parameter: fields[teams] | |
| filterByNoCostRate | No | Returns users who are missing cost rates(OCA only) | |
| ids | No | filter by user ids | |
| include | No | include (not used when generating reports) | |
| includeArchivedProjects | No | include archived projects in the report | |
| includeClients | No | include clients | |
| includeCollaborators | No | exclude collaborators types, returning only account and contact. | |
| includePlaceholders | No | include placeholder users | |
| includeServiceAccounts | No | include service accounts | |
| inclusiveFilter | No | make the filter inclusive for user ids, teamIds, companyIds | |
| isReportDownload | No | generate a report document | |
| jobRoleIds | No | filter by job role ids | |
| lastLoginAfter | No | Query parameter: lastLoginAfter | |
| onlyOwnerCompany | No | return people only from the owner company. This will replace any provided company ID. | |
| onlySiteOwner | No | Query parameter: onlySiteOwner | |
| orderBy | No | order by | |
| orderMode | No | order mode | |
| orderPrioritiseCurrentUser | No | Force to have the current/session user in the response | |
| page | No | page number (not used when generating reports) | |
| pageSize | No | number of items in a page (not used when generating reports) | |
| projectIds | No | filter by project ids | |
| reportFormat | No | define the format of the report | |
| searchTerm | No | filter by comment content | |
| searchUserJobRole | No | Include user job role in search | |
| selectedColumns | No | customise the report by selecting columns | |
| showDeleted | No | include deleted items | |
| skipCounts | No | SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons. | |
| startDate | No | start date for task completion report | |
| teamIds | No | team ids | |
| updatedAfter | No | date time | |
| userId | Yes | Path parameter: userId | |
| userType | No | user type |
Input Schema (JSON Schema)
{
"properties": {
"companyIds": {
"description": "company ids",
"type": "array"
},
"endDate": {
"description": "end date for task completion report",
"type": "string"
},
"excludeContacts": {
"description": "exclude contact types, returning only account and collaborator.",
"type": "boolean"
},
"excludeIds": {
"description": "exclude certain user ids",
"type": "array"
},
"excludeProjectIds": {
"description": "exclude people assigned to certain project id",
"type": "array"
},
"fieldsCompanies": {
"description": "Query parameter: fields[companies]",
"type": "array"
},
"fieldsPeople": {
"description": "Query parameter: fields[people]",
"type": "array"
},
"fieldsPerson": {
"description": "Query parameter: fields[person]",
"type": "array"
},
"fieldsProjectPermissions": {
"description": "Query parameter: fields[ProjectPermissions]",
"type": "array"
},
"fieldsTeams": {
"description": "Query parameter: fields[teams]",
"type": "array"
},
"filterByNoCostRate": {
"description": "Returns users who are missing cost rates(OCA only)",
"type": "boolean"
},
"ids": {
"description": "filter by user ids",
"type": "array"
},
"include": {
"description": "include (not used when generating reports)",
"type": "array"
},
"includeArchivedProjects": {
"description": "include archived projects in the report",
"type": "boolean"
},
"includeClients": {
"description": "include clients",
"type": "boolean"
},
"includeCollaborators": {
"description": "exclude collaborators types, returning only account and contact.",
"type": "boolean"
},
"includePlaceholders": {
"description": "include placeholder users",
"type": "boolean"
},
"includeServiceAccounts": {
"description": "include service accounts",
"type": "boolean"
},
"inclusiveFilter": {
"description": "make the filter inclusive for user ids, teamIds, companyIds",
"type": "boolean"
},
"isReportDownload": {
"description": "generate a report document",
"type": "boolean"
},
"jobRoleIds": {
"description": "filter by job role ids",
"type": "array"
},
"lastLoginAfter": {
"description": "Query parameter: lastLoginAfter",
"type": "string"
},
"onlyOwnerCompany": {
"description": "return people only from the owner company. This will replace any provided company ID.",
"type": "boolean"
},
"onlySiteOwner": {
"description": "Query parameter: onlySiteOwner",
"type": "boolean"
},
"orderBy": {
"description": "order by",
"enum": [
"id",
"name",
"namecaseinsensitive",
"overduetasks",
"assignedtasks",
"completedtasks",
"projects",
"activeprojects"
],
"type": "string"
},
"orderMode": {
"description": "order mode",
"enum": [
"asc",
"desc"
],
"type": "string"
},
"orderPrioritiseCurrentUser": {
"description": "Force to have the current/session user in the response",
"type": "boolean"
},
"page": {
"description": "page number (not used when generating reports)",
"type": "integer"
},
"pageSize": {
"description": "number of items in a page (not used when generating reports)",
"type": "integer"
},
"projectIds": {
"description": "filter by project ids",
"type": "array"
},
"reportFormat": {
"description": "define the format of the report",
"type": "string"
},
"searchTerm": {
"description": "filter by comment content",
"type": "string"
},
"searchUserJobRole": {
"description": "Include user job role in search",
"type": "boolean"
},
"selectedColumns": {
"description": "customise the report by selecting columns",
"type": "array"
},
"showDeleted": {
"description": "include deleted items",
"type": "boolean"
},
"skipCounts": {
"description": "SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.",
"type": "boolean"
},
"startDate": {
"description": "start date for task completion report",
"type": "string"
},
"teamIds": {
"description": "team ids",
"type": "array"
},
"updatedAfter": {
"description": "date time",
"type": "string"
},
"userId": {
"description": "Path parameter: userId",
"type": "integer"
},
"userType": {
"description": "user type",
"enum": [
"account",
"collaborator",
"contact"
],
"type": "string"
}
},
"required": [
"userId"
],
"type": "object"
}