Generates a project report in PDF format containing all projects for the
provided filters. Only the projects that the logged-in user can access will
be returned.
On this endpoint you can filter by project custom fields. The syntax for the
query parameter is the following:
projectCustomField[id][op]=value
Where:
- [id] is the custom field ID
- [op] is the operator to apply when filtering, different operators are
allowed according to the custom field type
- [value] is the value to apply when filtering
For example, if I want to filter a dropdown custom field with ID 10 to only
return entries that have the value "Option1" we would do the following:
projectCustomField[10][eq]=Option1
The allowed operators are:
- like
- not-like
- eq
- not
- lt
- gt
- any
type: object
properties:
parameters:
type: object
properties:
updatedAfter:
type: string
format: date-time
description: updated after
searchTerm:
type: string
description: filter by project name
reportType:
type: string
enum:
- project
- health
default: project
description: define the type of the report
reportTimezone:
type: string
description: Optional to configure the report dates displayed in a timezone
reportFormat:
type: string
enum:
- csv
- html
- pdf
- xls
default: pdf
description: define the format of the report
projectType:
type: string
description: filter by project type
orderMode:
type: string
enum:
- asc
- desc
default: asc
description: order mode
orderBy:
type: string
enum:
- companyname
- datecreated
- duedate
- lastactivity
- name
- namecaseinsensitive
- ownercompany
- starred
- categoryname
default: name
description: order by
minLastActivityDate:
type: string
format: date
description: filter by min last activity date
maxLastActivityDate:
type: string
format: date
description: filter by max last activity date
currencySymbol:
type: string
description: currency symbol for report export
userId:
type: integer
description: filter by user id
pageSize:
type: integer
default: '50'
description: number of items in a page (not used when generating reports)
page:
type: integer
default: '1'
description: page number (not used when generating reports)
orderByCustomFieldId:
type: integer
description: order by custom field id when orderBy is equal to customfield
searchCompanies:
type: boolean
description: include companies in the search
searchByLetter:
type: boolean
description: >-
search projects beginning with the search term character only when it
contains a single character.
onlyStarredProjects:
type: boolean
description: filter by starred projects only
onlyProjectsWithExplicitMembership:
type: boolean
default: 'false'
description: only show projects with explicit membership
onlyArchivedProjects:
type: boolean
default: 'false'
description: return only archived projects
matchAllProjectTags:
type: boolean
description: match all project tags
matchAllExcludedTags:
type: boolean
description: match all excluded project tags
isReportDownload:
type: boolean
default: 'false'
description: generate a report document
includeSubCategories:
type: boolean
description: include sub categories when filtering by ids
includeStats:
type: boolean
description: >-
include project status counts for tasks columns billing events
milestones
includeProjectUserInfo:
type: boolean
default: 'false'
description: fetch user-specific data such as isStarred
includeCustomFields:
type: boolean
default: 'false'
description: include custom fields
includeCounts:
type: boolean
description: include project related counts
includeCompletedStatus:
type: boolean
description: >-
optional to include completed projects when filtering by project
statuses "current,late".
includeArchivedProjects:
type: boolean
default: 'false'
description: include archived projects
hideObservedProjects:
type: boolean
default: 'false'
description: hide projects where the logged-in user is just an observer
alwaysIncludeFiltering:
type: boolean
description: includes filters when project ids are provided
teamIds:
type: array
items:
type: integer
description: filter by projects that contain users associated with the team ids
selectedColumns:
type: array
items:
type: string
description: select the columns to use in exports.
projectTagIds:
type: array
items:
type: integer
description: filter by project tag ids
projectStatuses:
type: array
items:
enum:
- active
- current
- late
- upcoming
- completed
- deleted
type: string
description: filter by project status
projectOwnerIds:
type: array
items:
type: integer
description: filter by project owner ids
projectIds:
type: array
items:
type: integer
description: filter by project ids
projectHealths:
type: array
items:
enum:
- '0'
- '1'
- '2'
- '3'
type: integer
description: |-
filter by project healths
0: not set
1: bad
2: ok
3: good
projectCompanyIds:
type: array
items:
type: integer
description: filter by company ids
projectCategoryIds:
type: array
items:
type: integer
description: filter by project category ids
include:
type: array
items:
enum:
- projectOwners
- projectUpdates
- companies
- companies.countries
- companies.industries
- projectCategories
- portfolioCards
- portfolioBoards
- portfolioColumns
- tags
- customfields
- customfieldProjects
- projectBudgets
- activities.latest
- users
- createdBy
- updatedBy
- completedBy
- deletedBy
type: string
description: include (not used when generating reports)
fields[workflows]:
type: array
items:
enum:
- id
- name
- statusId
type: string
fields[users]:
type: array
items:
enum:
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
type: string
fields[tags]:
type: array
items:
enum:
- id
- name
- color
- count
type: string
fields[stages]:
type: array
items:
enum:
- id
- name
- stage
type: string
fields[projects]:
type: array
items:
enum:
- id
- name
type: string
fields[projectcategories]:
type: array
items:
enum:
- id
- name
- color
- count
- parent
- parentId
type: string
fields[projectUpdates]:
type: array
items:
enum:
- id
- projectId
- text
- isActive
- health
- color
- dateCreated
- deleted
- deletedDate
- numLikes
- reactions
type: string
fields[projectBudgets]:
type: array
items:
enum:
- id
- projectId
- type
- status
- capacityUsed
- capacity
- originatorBudgetId
- isRepeating
- repeatPeriod
- repeatUnit
- repeatsRemaining
- sequenceNumber
- startDateTime
- endDateTime
- currencyCode
- timelogType
- expenseType
- defaultRate
- notificationIds
- createdByUserId
- dateCreated
- updatedUserId
- dateUpdated
- completedByUserId
- dateCompleted
- deletedByUserId
- dateDeleted
type: string
fields[portfolioColumns]:
type: array
items:
enum:
- id
- name
- color
type: string
fields[portfolioCards]:
type: array
items:
enum:
- id
- columnId
- projectId
type: string
fields[portfolioBoards]:
type: array
items:
enum:
- id
- name
- color
type: string
fields[industries]:
type: array
items:
type: string
fields[customfields]:
type: array
items:
enum:
- id
- projectId
- entity
- name
- description
- type
- options
- visibilities
- isPrivate
- required
- createdAt
- createdByUserId
- updatedAt
- updatedByUserId
- deleted
- deletedAt
- deletedByUserId
type: string
fields[customfieldProjects]:
type: array
items:
enum:
- id
- customfieldId
- value
- createdAt
- createdBy
type: string
fields[countries]:
type: array
items:
type: string
fields[companies]:
type: array
items:
enum:
- id
- name
- logoUploadedToServer
- logoImage
type: string
featuresEnabled:
type: array
items:
enum:
- list
- board
- gantt
- table
- dashboard
- milestones
- messages
- files
- time
- notebooks
- risks
- links
- billing
- comments
- people
- settings
type: string
description: filter by projects that have features enabled
excludeTagIds:
type: array
items:
type: integer
description: exclude by project tag ids
title: Parameters