ClickUp: Most-used fields

ClickUp: Most-used fields#

The table below gives information about most-used fields that you can import from ClickUp. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Progress.percent_complete

Progress.percent_complete

The percentage of completion for a task or a progress-related custom field.

metric

Task Progress.percent_complete

Task Progress.percent_complete

The percentage of completion for the task.

metric

archived

archived

A boolean indicating whether an entity (e.g., Space, Folder, List, or Task) is archived.

dimension

assignees.color

assignees.color

The color associated with the user profile of an assignee.

dimension

assignees.email

assignees.email

The email address of a user assigned to the task.

dimension

assignees.id

assignees.id

The unique identifier of a user assigned to the task.

metric

assignees.initials

assignees.initials

The initials of a user assigned to the task.

dimension

assignees.profilePicture

assignees.profilePicture

The URL to the profile picture of a user assigned to the task.

dimension

assignees.username

assignees.username

The username of a user assigned to the task.

dimension

creator.color

creator.color

The color associated with the user profile of the task’s creator.

dimension

creator.email

creator.email

The email address of the user who created the task.

dimension

creator.id

creator.id

The unique identifier of the user who created the task.

metric

creator.profilePicture

creator.profilePicture

The URL to the profile picture of the task’s creator.

dimension

creator.username

creator.username

The username of the person who created the task.

dimension

custom_id

custom_id

A custom identifier for the task, often used for external system integration. This is an optional field set by the user.

dimension

date_closed

date_closed

The date and time when the task was marked as closed, in Unix time in milliseconds.

dimension

date_created

date_created

The date and time when the task or item was created, in Unix time in milliseconds.

dimension

date_updated

date_updated

The date and time when the task or item was last updated, in Unix time in milliseconds.

dimension

description

description

A detailed description of the task or item.

dimension

due_date

due_date

The date and time when the task is due, in Unix time in milliseconds.

dimension

folder.access

folder.access

A boolean indicating if the current user has access to the folder.

dimension

folder.hidden

folder.hidden

A boolean indicating if the folder is hidden from view.

dimension

folder.id

folder.id

The unique identifier of the folder.

metric

folder.name

folder.name

The name of the folder.

dimension

id

id

The unique identifier of the task or item.

dimension

list.access

list.access

A boolean indicating if the current user has access to the list.

dimension

list.id

list.id

The unique identifier of the list containing the task.

metric

list.name

list.name

The name of the list containing the task.

dimension

name

name

The name or title of the task or item.

dimension

orderindex

orderindex

The numerical index used to determine the order of the item within its parent (e.g., task within a list, list within a folder).

metric

parent

parent

The unique identifier of the parent task, if the current item is a subtask.

dimension

permission_level

permission_level

The permission level of the current user for the item.

dimension

points

points

The number of points assigned to the task, used to quantify task size or effort.

metric

priority

priority

The priority level of the task.

dimension

priority.color

priority.color

The color associated with the task’s priority level.

dimension

priority.id

priority.id

The unique identifier of the task’s priority level.

metric

priority.orderindex

priority.orderindex

The numerical index used to determine the order of the task’s priority.

metric

priority.priority

priority.priority

The name of the task’s priority level (e.g., ‘Urgent’, ‘High’, ‘Normal’, ‘Low’).

dimension

project.access

project.access

Defines the access level or permissions granted to a specific project within ClickUp.

dimension

project.hidden

project.hidden

Boolean flag indicating if the project is hidden from view.

dimension

project.id

project.id

The unique identifier for a project in ClickUp, which corresponds to a Space, Folder, or List.

metric

project.name

project.name

The name of the project, which corresponds to a Space, Folder, or List in ClickUp.

dimension

space

space

The name or object representing the Space where the item is located.

dimension

space.id

space.id

The unique identifier of the Space where the item is located.

metric

start_date

start_date

The date and time when the task is scheduled to start, in Unix time in milliseconds.

dimension

status.color

status.color

The color associated with the task’s status.

dimension

status.orderindex

status.orderindex

The numerical index used to determine the order of the task’s status within its workflow.

metric

status.status

status.status

The name of the task’s status (e.g., ‘Open’, ‘In Progress’, ‘Complete’).

dimension

status.type

status.type

The type of the task’s status (e.g., ‘open’, ‘closed’, ‘custom’).

dimension

tags.name

tags.name

The name of a tag associated with the task.

dimension

team

team

The name or object representing the Team (Workspace) where the item is located.

dimension

team_id

team_id

The unique identifier of the Team (Workspace) where the item is located.

dimension

text_content

text_content

The plain text content of the task’s description or other text fields.

dimension

time_estimate

time_estimate

The estimated time required to complete the task, in milliseconds.

dimension

time_estimates_by_user.{NUM}.time_estimate

time_estimates_by_user.{NUM}.time_estimate

The estimated time for a task by a specific user, expressed in milliseconds.

metric

time_estimates_by_user.{NUM}.user.color

time_estimates_by_user.{NUM}.user.color

The color assigned to the user within ClickUp, typically used for visual identification in the user interface.

dimension

time_estimates_by_user.{NUM}.user.email

time_estimates_by_user.{NUM}.user.email

The email address associated with the user’s ClickUp account.

dimension

time_estimates_by_user.{NUM}.user.id

time_estimates_by_user.{NUM}.user.id

A unique identifier for the user within ClickUp.

metric

time_estimates_by_user.{NUM}.user.initials

time_estimates_by_user.{NUM}.user.initials

The initials of the user, often used as a shorthand representation of their name.

dimension

time_estimates_by_user.{NUM}.user.profilePicture

time_estimates_by_user.{NUM}.user.profilePicture

The URL or data for the user’s profile picture in ClickUp.

dimension

time_estimates_by_user.{NUM}.user.username

time_estimates_by_user.{NUM}.user.username

The username of the user in ClickUp.

dimension

time_spent

time_spent

The total time spent on the task, in milliseconds. This field is only included for tasks with time entries.

metric

url

url

The URL to access the task or item in ClickUp.

dimension