GET/projects/api/v3/reporting/precanned/usertaskcompletion.json

Returns task completions for all users

Retrieve all people for the provided filters and their task completions.

Query Params

  • Name
    userType
    Type
    string
    Description

    user type

    Allowed values
    • account
    • collaborator
    • contact
  • Name
    updatedAfter
    Type
    string
    Description

    date time

  • Name
    startDate
    Type
    string
    Description

    start date for task completion report

  • Name
    searchTerm
    Type
    string
    Description

    filter by comment content

  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    name
    Allowed values
    • id
    • name
    • namecaseinsensitive
    • overduetasks
    • assignedtasks
    • completedtasks
    • projects
    • activeprojects
    • (depreciated)
  • Name
    lastLoginAfter
    Type
    string
    Description
  • Name
    endDate
    Type
    string
    Description

    end date for task completion report

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page (not used when generating reports)

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number (not used when generating reports)

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    showDeleted
    Type
    boolean
    Description

    include deleted items

    Default
    false
  • Name
    searchUserJobRole
    Type
    boolean
    Description

    Include user job role in search

  • Name
    orderPrioritiseCurrentUser
    Type
    boolean
    Description

    Force to have the current/session user in the response

  • Name
    onlySiteOwner
    Type
    boolean
    Description
    Default
    false
  • Name
    onlyOwnerCompany
    Type
    boolean
    Description

    return people only from the owner company. This will replace any provided company ID.

    Default
    false
  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report document

  • Name
    inclusiveFilter
    Type
    boolean
    Description

    make the filter inclusive for user ids, teamIds, companyIds

    Default
    false
  • Name
    includeServiceAccounts
    Type
    boolean
    Description

    include service accounts

    Default
    false
  • Name
    includePlaceholders
    Type
    boolean
    Description

    include placeholder users

    Default
    false
  • Name
    includeCollaborators
    Type
    boolean
    Description

    exclude collaborators types, returning only account and contact.

    Default
    true
  • Name
    includeClients
    Type
    boolean
    Description

    include clients

    Default
    true
  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects in the report

    Default
    false
  • Name
    filterByNoCostRate
    Type
    boolean
    Description

    Returns users who are missing cost rates(OCA only)

  • Name
    excludeContacts
    Type
    boolean
    Description

    exclude contact types, returning only account and collaborator.

    Default
    false
  • Name
    adminsOnly
    Type
    boolean
    Description

    only include users with administrator status in the response

    Default
    false
  • Name
    teamIds
    Type
    array[integer]
    Description

    team ids

    Format
    Comma separated values
  • Name
    selectedColumns
    Type
    array[string]
    Description

    customise the report by selecting columns

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    jobRoleIds
    Type
    array[integer]
    Description

    filter by job role ids

    Format
    Comma separated values
  • Name
    jobRoleIds
    Type
    array[integer]
    Description

    filter by job role ids

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include (not used when generating reports)

    Format
    Comma separated values
    Allowed values
    • users
  • Name
    ids
    Type
    array[integer]
    Description

    filter by user ids

    Format
    Comma separated values
  • Name
    fields[userIntegrations]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • userId
    • projectId
    • canAccessBox
    • canAccessDropbox
    • canAccessGoogleDocs
    • canAccessOneDrive
    • canAccessOneDriveBusiness
    • canAccessSharePoint
  • Name
    fields[teams]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • teamLogo
    • teamLogoIcon
    • teamLogoColor
  • Name
    fields[person]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[people]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • Name
    fields[ProjectPermissions]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • viewMessagesAndFiles
    • viewTasksAndMilestones
    • viewTime
    • viewNotebooks
    • viewRiskRegister
    • viewEstimatedTime
    • viewInvoices
    • addTasks
    • addRisks
    • manageCustomFields
    • addExpenses
    • editAllTasks
    • addMilestones
    • addTaskLists
    • addMessages
    • addFiles
    • addTime
    • addNotebooks
    • viewLinks
    • addLinks
    • canViewForms
    • addForms
    • viewAllTimeLogs
    • setPrivacy
    • projectAdministrator
    • viewProjectUpdate
    • addProjectUpdate
    • canViewProjectMembers
    • canViewProjectBudget
    • canManageProjectBudget
    • canViewRates
    • canManageRates
    • canViewSchedule
    • canManageSchedule
    • receiveEmailNotifications
    • isObserving
    • isArchived
    • active
    • canAccess
    • inOwnerCompany
    • canManagePeople
    • canViewProjectTemplates
    • canManageProjectTemplates
  • Name
    excludeProjectIds
    Type
    array[integer]
    Description

    exclude people assigned to certain project id

    Format
    Comma separated values
  • Name
    excludeIds
    Type
    array[integer]
    Description

    exclude certain user ids

    Format
    Comma separated values
  • Name
    emails
    Type
    array[string]
    Description

    filter by user emails

    Format
    Comma separated values
  • Name
    companyIds
    Type
    array[integer]
    Description

    company ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    TaskCompletionResponse contains information about tasks completed by a user.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

TaskCompletionResponse
{
  "included": {
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAccessPortfolio": true,
        "canAddProjects": true,
        "canManagePortfolio": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isPlaceholderResource": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastLogin": "string",
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "skills": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userCost": 0,
        "userRate": 0,
        "userRates": {
          "additionalProp": {
            "amount": 0,
            "currency": {
              "id": 0,
              "meta": {},
              "type": "string"
            }
          }
        },
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  },
  "taskCompletions": {
    "totalActiveProjects": 0,
    "totalAssignedTasks": 0,
    "totalCompletedTasks": 0,
    "totalOverdueTasks": 0,
    "totalProjects": 0,
    "users": [
      {
        "activeProjects": 0,
        "assignedTasks": 0,
        "completedTasks": 0,
        "overdueTasks": 0,
        "projects": 0,
        "userId": 0
      }
    ]
  }
}
Download Swagger