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 |
Space URL |
Space URL |
The unique URL identifying a specific Space within ClickUp. Spaces are top-level organizational containers within a Workspace. |
dimension |
Task Progress.percent_complete |
Task Progress.percent_complete |
The percentage of completion for the task. |
metric |
User Name |
User Name |
The display name of the user associated with a ClickUp account. |
dimension |
User Type |
User Type |
The role or type of the user within a Workspace, such as Member, Guest, or Admin. |
dimension |
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 |
attachments.{NUM}.date |
attachments.{NUM}.date |
The date and time when the attachment was uploaded or last modified. |
metric |
attachments.{NUM}.deleted |
attachments.{NUM}.deleted |
A boolean flag indicating whether the attachment has been deleted. |
dimension |
attachments.{NUM}.email_data |
attachments.{NUM}.email_data |
dimension |
|
attachments.{NUM}.email_data.client |
attachments.{NUM}.email_data.client |
dimension |
|
attachments.{NUM}.email_data.email |
attachments.{NUM}.email_data.email |
dimension |
|
attachments.{NUM}.email_data.from |
attachments.{NUM}.email_data.from |
dimension |
|
attachments.{NUM}.email_data.id |
attachments.{NUM}.email_data.id |
dimension |
|
attachments.{NUM}.email_data.msg |
attachments.{NUM}.email_data.msg |
dimension |
|
attachments.{NUM}.email_data.subject |
attachments.{NUM}.email_data.subject |
dimension |
|
attachments.{NUM}.extension |
attachments.{NUM}.extension |
The file extension of the attached file (e.g., ‘pdf’, ‘jpg’). |
dimension |
attachments.{NUM}.hidden |
attachments.{NUM}.hidden |
dimension |
|
attachments.{NUM}.id |
attachments.{NUM}.id |
The unique identifier for the attachment. |
dimension |
attachments.{NUM}.is_folder |
attachments.{NUM}.is_folder |
dimension |
|
attachments.{NUM}.mimetype |
attachments.{NUM}.mimetype |
The MIME type (e.g., ‘image/jpeg’, ‘application/pdf’) of the attached file. |
dimension |
attachments.{NUM}.orientation |
attachments.{NUM}.orientation |
dimension |
|
attachments.{NUM}.parent_id |
attachments.{NUM}.parent_id |
The ID of the parent entity, typically a task, to which this attachment is linked. |
dimension |
attachments.{NUM}.resolved_comments |
attachments.{NUM}.resolved_comments |
metric |
|
attachments.{NUM}.size |
attachments.{NUM}.size |
The size of the attachment file in bytes. |
metric |
attachments.{NUM}.source |
attachments.{NUM}.source |
The source platform or method from which the attachment was uploaded (e.g., ‘Google Drive’, ‘local file’). |
metric |
attachments.{NUM}.thumbnail_large |
attachments.{NUM}.thumbnail_large |
The URL for a large thumbnail image preview of the attachment, if available. |
dimension |
attachments.{NUM}.thumbnail_medium |
attachments.{NUM}.thumbnail_medium |
The URL for a medium thumbnail image preview of the attachment, if available. |
dimension |
attachments.{NUM}.thumbnail_small |
attachments.{NUM}.thumbnail_small |
The URL for a small thumbnail image preview of the attachment, if available. |
dimension |
attachments.{NUM}.title |
attachments.{NUM}.title |
The display title or name of the attached file. |
dimension |
attachments.{NUM}.total_comments |
attachments.{NUM}.total_comments |
metric |
|
attachments.{NUM}.type |
attachments.{NUM}.type |
The general category or type of the attachment (e.g., ‘image’, ‘document’, ‘file’). |
metric |
attachments.{NUM}.url |
attachments.{NUM}.url |
The direct URL to access or download the attachment file. |
dimension |
attachments.{NUM}.url_w_host |
attachments.{NUM}.url_w_host |
The full URL to access the attachment, including the host domain. |
dimension |
attachments.{NUM}.url_w_query |
attachments.{NUM}.url_w_query |
The full URL to access the attachment, including any necessary query parameters. |
dimension |
attachments.{NUM}.user.color |
attachments.{NUM}.user.color |
The color assigned to the user in the ClickUp user interface, who uploaded the attachment. |
dimension |
attachments.{NUM}.user.email |
attachments.{NUM}.user.email |
The email address of the user who uploaded the attachment. |
dimension |
attachments.{NUM}.user.id |
attachments.{NUM}.user.id |
The unique identifier of the user who uploaded the attachment. |
metric |
attachments.{NUM}.user.initials |
attachments.{NUM}.user.initials |
The initials of the user who uploaded the attachment. |
dimension |
attachments.{NUM}.user.profilePicture |
attachments.{NUM}.user.profilePicture |
The URL to the profile picture of the user who uploaded the attachment. |
dimension |
attachments.{NUM}.user.username |
attachments.{NUM}.user.username |
The username of the user who uploaded the attachment. |
dimension |
attachments.{NUM}.version |
attachments.{NUM}.version |
metric |
|
checklists.creator |
checklists.creator |
The user who created the checklist. |
metric |
checklists.date_created |
checklists.date_created |
The date and time when the checklist was created. |
metric |
checklists.id |
checklists.id |
The unique identifier for the checklist. |
dimension |
checklists.items |
checklists.items |
A list of individual items within the checklist. |
dimension |
checklists.name |
checklists.name |
The name or title of the checklist. |
dimension |
checklists.orderindex |
checklists.orderindex |
The order index of the checklist within its parent item, determining its display order. |
metric |
checklists.resolved |
checklists.resolved |
The number of items in the checklist that have been marked as resolved or completed. |
metric |
checklists.task_id |
checklists.task_id |
The unique identifier of the task to which this checklist belongs. |
dimension |
checklists.unresolved |
checklists.unresolved |
The number of items in the checklist that are currently unresolved or incomplete. |
metric |
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_done |
date_done |
The date and time when a task or item was marked as done or completed. |
dimension |
date_updated |
date_updated |
The date and time when the task or item was last updated, in Unix time in milliseconds. |
dimension |
dependencies.chain_id |
dependencies.chain_id |
dimension |
|
dependencies.date_created |
dependencies.date_created |
The date and time when the task dependency was created. |
metric |
dependencies.depends_on |
dependencies.depends_on |
The unique identifier of the task that must be completed before the current task can start. |
dimension |
dependencies.task_id |
dependencies.task_id |
The unique identifier of the task for which this dependency is defined. |
dimension |
dependencies.type |
dependencies.type |
The type of relationship between dependent tasks, such as ‘waiting on’, ‘blocking’, or ‘linked’. |
metric |
dependencies.userid |
dependencies.userid |
The unique identifier of the user who created this task dependency. |
metric |
dependencies.workspace_id |
dependencies.workspace_id |
The unique identifier of the Workspace where the task dependency is established. |
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 |
linked_tasks.date_created |
linked_tasks.date_created |
The date and time when the link to the task was created. |
metric |
linked_tasks.link_id |
linked_tasks.link_id |
The unique identifier for the specific link between tasks. |
dimension |
linked_tasks.task_id |
linked_tasks.task_id |
The unique identifier of the linked task. |
dimension |
linked_tasks.userid |
linked_tasks.userid |
The unique identifier of the user who created the task link. |
metric |
linked_tasks.workspace_id |
linked_tasks.workspace_id |
The unique identifier of the workspace to which the linked task belongs. |
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 |
locations.{NUM}.id |
locations.{NUM}.id |
The unique identifier of a hierarchical location within ClickUp (e.g., Space ID, Folder ID, List ID). |
metric |
locations.{NUM}.name |
locations.{NUM}.name |
The name of a hierarchical location within ClickUp (e.g., Space Name, Folder Name, List Name). |
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.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 |
sharing.permission_level |
sharing.permission_level |
The level of access a user or group has to a shared item (e.g., task, list, folder). Possible values include ‘Full edit’, ‘Edit’, ‘Comment’, and ‘View only’. |
metric |
sharing.permissions.can_comment |
sharing.permissions.can_comment |
Indicates whether the user or group has permission to add and reply to comments on a shared item or location. |
dimension |
sharing.permissions.name |
sharing.permissions.name |
The name of the entity associated with a specific permission entry, such as a user, a user group (team), or a custom role. |
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.id |
status.id |
The unique identifier of the task’s current status (e.g., ‘open’, ‘in progress’, ‘complete’). |
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, in milliseconds, that a specific user (assignee) is expected to spend on a task. This allows for individual time estimates when multiple users are assigned to the same task. |
metric |
time_estimates_by_user.{NUM}.user.color |
time_estimates_by_user.{NUM}.user.color |
The user’s assigned color in ClickUp, associated with their time estimate. |
dimension |
time_estimates_by_user.{NUM}.user.email |
time_estimates_by_user.{NUM}.user.email |
The email address of the user who provided the time estimate. |
dimension |
time_estimates_by_user.{NUM}.user.id |
time_estimates_by_user.{NUM}.user.id |
The unique identifier of the user who provided the time estimate. |
metric |
time_estimates_by_user.{NUM}.user.initials |
time_estimates_by_user.{NUM}.user.initials |
The initials of the user who provided the time estimate. |
dimension |
time_estimates_by_user.{NUM}.user.profilePicture |
time_estimates_by_user.{NUM}.user.profilePicture |
URL to the profile picture of the user who provided the time estimate. |
dimension |
time_estimates_by_user.{NUM}.user.username |
time_estimates_by_user.{NUM}.user.username |
The username of the user who provided the time estimate. |
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 |
watchers.color |
watchers.color |
The user’s assigned color in ClickUp for a watcher. |
dimension |
watchers.email |
watchers.email |
The email address of the user watching an item. |
dimension |
watchers.id |
watchers.id |
The unique identifier of a user watching an item. |
metric |
watchers.initials |
watchers.initials |
The initials of the user watching an item. |
dimension |
watchers.profilePicture |
watchers.profilePicture |
URL to the profile picture of the user watching an item. |
dimension |
watchers.username |
watchers.username |
The username of the user watching an item. |
dimension |