Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Zendesk: Most-used fields

The table below gives information about most-used fields that you can import from Zendesk. 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.

FieldAdverity UI nameType
activeMetric

Indicates whether this field or entity is currently available and in use.

aliasDimension

An alternate name or identifier for a user, often displayed to end-users.

allow_attachmentsDimension

Indicates whether agents have permission to add attachments to a comment within a ticket.

allow_channelbackDimension

Indicates if channelback functionality is enabled for a ticket, allowing replies to be sent back to the original channel.

assignee_idDimension

The ID of the agent currently assigned to the ticket.

brand_idMetric

The ID of the brand associated with the ticket.

chat_onlyDimension

A boolean value indicating whether the user is restricted to only interacting via chat channels.

collaborator_ids.{NUM}Dimension

The IDs of users currently copied (CC'ed) on the ticket, indicating who is collaborating on the ticket.

created_atDimension

Timestamp indicating when the record was created.

created_at_dateDimension

The date when the record was created.

custom_fields.{NUM}Dimension

A custom data point defined by the user in Zendesk, such as a custom ticket field, user field, or organization field. The numerical suffix represents the unique identifier of that specific custom field.

custom_role_idDimension

The ID of a custom role assigned to a user.

custom_status_idMetric

The ID of the custom ticket status applied to the ticket.

dateDimension

A field that captures a date value.

default_group_idDimension

The unique identifier of the user's default group.

descriptionDimension

A description of the SLA policy or general details about an organization.

detailsDimension

Any additional information or details about the organization.

due_atDimension

The due date for a ticket of type 'task', formatted in ISO 8601.

emailDimension

The email address of the user.

email_cc_ids.{NUM}Dimension

The IDs of agents or end-users who are currently email CC recipients on the ticket.

encoded_idDimension

An encoded string representing the ticket's unique identifier.

external_idDimension

A unique identifier from an external system used to link Zendesk records to external records.

follower_ids.{NUM}Dimension

The IDs of agents who are currently following the ticket, indicating their interest in its progress.

followup_ids.{NUM}Dimension

This field contains a list of IDs for tickets that were created as follow-ups from the current ticket. These IDs become visible once the original ticket is closed.

forum_topic_idDimension

The ID of the forum topic from which a ticket originated, if applicable.

from_messaging_channelDimension

Indicates if the ticket's 'via' type is a messaging channel.

generated_timestampMetric

A Unix timestamp representing the most accurate reading of when the record was last updated, including system updates.

group_idDimension

The ID of the group a ticket is assigned to, or the ID of a group associated with an organization.

has_incidentsDimension

Indicates if a problem-type ticket has one or more incidents linked to it.

iana_time_zoneDimension

The IANA (Internet Assigned Numbers Authority) time zone designation for a user or account.

idMetric

The unique identifier automatically assigned when a record is created.

is_billing_adminDimension

Indicates whether the user has the role of a billing administrator.

is_publicDimension

Indicates if a comment or thread is visible to the ticket requester (public) or only to agents (private).

last_login_atDimension

Timestamp indicating when the user last logged into their account.

last_login_at_dateDimension

The date when the user last logged into their account.

localeDimension

The locale of a user or the language setting for displaying dynamic content variants.

locale_idDimension

The unique identifier for the language and region (locale) setting for a user or an account.

moderatorDimension

A boolean value indicating whether the user has forum moderation capabilities within Zendesk.

nameDimension

The full name of the user or the unique name of the organization.

notesDimension

Any additional notes about the user or organization.

only_private_commentsDimension

Indicates whether the user can only create private comments on tickets.

organization_idDimension

The ID of the organization associated with the requester or ticket.

phoneDimension

The primary phone number of the user.

photoDimension

An object representing the user's profile picture as an attachment.

photo.content_typeDimension

The MIME type of the user's profile picture.

photo.content_urlDimension

The URL to access the content of the user's profile picture.

photo.deletedDimension

Indicates if the user's profile picture has been deleted.

photo.file_nameDimension

The file name of the user's profile picture.

photo.heightDimension

The height of the user's profile picture in pixels.

photo.idDimension

The ID of the user's profile picture attachment.

photo.inlineDimension

Indicates if the user's profile picture is displayed inline.

photo.mapped_content_urlDimension

The mapped URL to access the content of the user's profile picture.

photo.sizeDimension

The file size of the user's profile picture in bytes.

photo.thumbnails.{NUM}.content_typeDimension

The MIME type of a specific thumbnail for the user's profile picture.

photo.thumbnails.{NUM}.content_urlDimension

The URL to access the content of a specific thumbnail for the user's profile picture.

photo.thumbnails.{NUM}.deletedDimension

Indicates if a specific thumbnail for the user's profile picture has been deleted.

photo.thumbnails.{NUM}.file_nameDimension

The file name of a specific thumbnail for the user's profile picture.

photo.thumbnails.{NUM}.heightMetric

The height of a specific thumbnail for the user's profile picture in pixels.

photo.thumbnails.{NUM}.idMetric

The ID of a specific thumbnail for the user's profile picture.

photo.thumbnails.{NUM}.inlineDimension

Indicates if a specific thumbnail for the user's profile picture is displayed inline.

photo.thumbnails.{NUM}.mapped_content_urlDimension

The mapped URL to access the content of a specific thumbnail for the user's profile picture.

photo.thumbnails.{NUM}.sizeMetric

The file size of a specific thumbnail for the user's profile picture in bytes.

photo.thumbnails.{NUM}.urlDimension

The URL of a specific thumbnail for the user's profile picture.

photo.thumbnails.{NUM}.widthMetric

The width of a specific thumbnail for the user's profile picture in pixels.

photo.urlDimension

The URL of the user's profile picture.

photo.widthDimension

The width of the user's profile picture in pixels.

priorityMetric

The urgency level of the ticket, such as 'urgent', 'high', 'normal', or 'low'.

problem_idDimension

For 'incident' type tickets, the ID of the linked problem ticket.

raw_subjectDimension

The unprocessed or original subject line of a ticket.

recipientDimension

The original recipient email address of the ticket; notifications are sent from this address.

report_csvDimension

A compiled report in CSV format, containing various Zendesk support ticket workflow data such as tickets, ticket metrics, ticket metric events, user details, organizations, ticket audits, and satisfaction ratings.

requester_idMetric

The ID of the user who requested the ticket.

restricted_agentDimension

Indicates if the user has a restricted agent role.

result_typeDimension

This field indicates the type of object returned by a search query, such as 'ticket', 'organization', 'user', or 'group'. It helps identify the specific resource found in the search results.

roleDimension

The role of the user, such as 'end-user', 'agent', or 'admin'.

role_typeDimension

An integer representing the type of role assigned to a user (e.g., 0 for custom agent, 4 for admin, 5 for billing admin).

satisfaction_rating.commentDimension

The comment provided by the user when submitting a satisfaction rating.

satisfaction_rating.idDimension

The ID of the satisfaction rating.

satisfaction_rating.reasonDimension

The reason provided for a negative satisfaction rating.

satisfaction_rating.reason_idDimension

The ID of the reason provided for a negative satisfaction rating.

satisfaction_rating.scoreDimension

The score of the satisfaction rating, such as 'good', 'bad', 'offered', or 'unoffered'.

sharedDimension

Indicates whether the user account is shared from a different Zendesk Support instance through ticket sharing agreements.

shared_agentDimension

Indicates whether the user is a shared agent from another Zendesk account.

shared_phone_numberDimension

Indicates whether the user's phone number is shared.

signatureDimension

The agent's signature, often appended to outgoing communications.

statusDimension

The current state category of the ticket, such as 'new', 'open', 'pending', 'hold', 'solved', or 'closed'.

subjectDimension

The subject line of the ticket, often provided by the requester.

submitter_idDimension

The ID of the user who submitted or created the ticket.

support_typeDimension

This field specifies the type of entity that provided support for a ticket. Possible values are 'agent' for human support or 'ai_agent' for artificial intelligence-driven support.

suspendedDimension

Indicates if a user's account is suspended.

suspension_detailsDimension

Provides details about why a ticket or user was suspended, including the cause and any associated error messages.

suspension_details.channels.{NUM}Dimension

Details about the specific communication channels from which a user has been suspended in Zendesk. This indicates if a user is restricted from interacting via channels such as messaging, email, or other supported communication methods.

tags.{NUM}Dimension

An array of string labels or keywords associated with the ticket, used for categorization and management.

ticket_form_idDimension

The ID of the ticket form rendered for the ticket.

ticket_restrictionDimension

This field defines the access restrictions for a user concerning ticket visibility. It controls which tickets a user, especially an end-user, can view or interact with within Zendesk Support, such as limiting access to only their own tickets, tickets within their organization, or all tickets.

time_zoneDimension

The time zone of the user, as an offset from UTC.

two_factor_auth_enabledDimension

Indicates whether two-factor authentication (2FA) is enabled for the user's account.

typeDimension

The type of the ticket (e.g., 'problem', 'incident', 'question', 'task'), the type of metric event, or the type of the ticket field.

updated_atDimension

Timestamp indicating when the record was last updated.

updated_at_dateDimension

The date when the record was last updated.

urlDimension

The API URL for this resource.

via.channelDimension

The channel through which the ticket or event originated, e.g., 'web', 'email', 'rule', 'suspended_ticket'.

via.source.from.addressDimension

The email address from which the ticket originated.

via.source.from.brand_idDimension

The unique identifier of the brand from which the ticket originated. Zendesk allows multiple brands within a single account, and this field specifies the brand associated with the ticket's creation source.

via.source.from.channelDimension

The communication channel from which the ticket originated, such as email, web, or chat. This is part of the 'via' object, which provides context on how an action or event was created.

via.source.from.facebook_idDimension

The Facebook ID from which the ticket originated.

via.source.from.formatted_phoneDimension

The formatted phone number from which the ticket originated.

via.source.from.nameDimension

The name associated with the source from which the ticket originated.

via.source.from.phoneDimension

The phone number from which an inbound phone call ticket originated. This field is part of the 'via' object, which details the channel through which a ticket or event was created.

via.source.from.profile_urlDimension

The profile URL associated with the source from which the ticket originated.

via.source.from.service_info.integration_service_instance_nameDimension

The name of the specific instance of an integration service that initiated or contributed to a ticket event or update. This field is part of the 'via' object, which describes the origin of a ticket or event.

via.source.from.service_info.registered_integration_service_external_idDimension

A unique identifier assigned by an external system to a specific integration service registered within Zendesk. This ID facilitates tracking and correlating data between the external system and the Zendesk Integration Services (ZIS) platform.

via.source.from.service_info.registered_integration_service_nameDimension

The name of the integration service, as registered with Zendesk, that was the source of a ticket event or update. This is part of the 'via' object, providing context on how the event originated.

via.source.from.service_info.supports_channelbackDimension

A boolean indicator that is true if the integration service originating the ticket event or update supports 'channelback,' meaning it can send agent replies from Zendesk back to the original external service or channel.

via.source.from.service_info.supports_clickthroughDimension

A boolean indicator that is true if the integration service originating the ticket event or update supports 'clickthrough,' allowing agents to click links within Zendesk tickets to view the original external resource in the source system.

via.source.from.subjectDimension

The subject or title of the ticket as it was provided by the original source or channel during the ticket's creation. This provides context about the initial inquiry before any potential modifications.

via.source.from.ticket_idDimension

The ID of the original ticket if this ticket was created as a follow-up, indicating the parent ticket from which it originated. This is part of the 'via' object which provides context on how an action or event was created.

via.source.from.twitter_idDimension

The Twitter ID from which the ticket originated.

via.source.from.usernameDimension

The username from which the ticket originated.

via.source.relDimension

The relationship type of the source, e.g., 'trigger', 'suspended_ticket'.

via.source.to.addressDimension

The email address to which the ticket was sent.

via.source.to.brand_idDimension

The brand ID associated with the destination of the ticket.

via.source.to.facebook_idDimension

The Facebook ID to which the ticket was sent.

via.source.to.formatted_phoneDimension

The formatted phone number to which the ticket was sent.

via.source.to.nameDimension

The name associated with the destination of the ticket.

via.source.to.phoneDimension

The phone number to which an outbound phone call ticket was directed. This field is part of the 'via' object, detailing the channel through which a ticket or event was created.

via.source.to.profile_urlDimension

The profile URL associated with the destination of the ticket.

via.source.to.twitter_idDimension

The Twitter ID to which the ticket was sent.

via.source.to.usernameDimension

The username to which the ticket was sent.