Search Operators in Onna
  • 16 Aug 2024
  • 126 Minutes to read
  • Dark
    Light
  • PDF

Search Operators in Onna

  • Dark
    Light
  • PDF

Article summary

In this article:

  • Operator and Search Term Formats

  • Dates Operators

  • Email Operators

  • Metadata Operators

  • Source Specific Operators

    • Confluence Operators

    • Jira Operators

    • Slack Enterprise Operators

    • Zendesk Operators

  • API Ticket Operators

Operator and Search Term Formats

Boolean Operators

  • AND: Use of this Boolean operator will combine multiple search operators and their associated terms and will provide only results that match all the operators/terms.

  • OR: Use of this Boolean operator will return results associated with any search operators and associated terms that are combined using OR within the search query.

  • NOT: Use of this Boolean operator will exclude results associated with any search operator and associated terms that are listed after ‘NOT’ in a search query.

  • "has": This Boolean operator specifies that the search should return results that possess the specified attribute or feature. For example, "has:attachment" would return resources that contain attachments.

  • "is": This Boolean operator specifies that the search should return results that exactly match the specified condition. For example, "is:attachment" will return only resources that are attachments to another parent resource.

Operator Syntax Format

It is important to know that search operator syntax is case sensitive and must be lower-case.

Results for Specific Metadata Fields

  • To include all results where a specific metadata field is set use an asterisk after your syntax. For example:

    • from:* will return all results where the “from” metadata field is set.

  • To include only results where a specific metadata field is NOT set, use an asterisk after your syntax and add the word ‘not’ to the beginning of the syntax. For example:

    • NOT from:* will return all results where the “from” metadata field is NOT set.

Searching Multiple Terms

To include multiple search terms within your query as an OR statement you can use a ‘,’. For example (Not supported for all syntax/operators):

Date Term Format

  • When entering dates use the format MM/DD/YYYY

  • All time zones are stored in UTC. For example:

    • (01/01/2020 8PM CST = 01/02/2020 1:00 AM )

    • (01/01/2020 9PM EST = 01/02/2020 1:00 AM )

    • (01/01/2020 6PM PST = 01/02/2020 1:00 AM )

  • Supported characters include: numbers, /

Keyword Term Format

  • Keyword fields are considered to be a sequence of structured characters, like an email address, UUID, or zip code. When searching a keyword field, the search term must be an exact match.

    • For example, if you are attempting to find records for the metadata field ‘channel’ with a of value 'global-news’, then you must provide this exactly. ‘global-’ or just ‘news’ and so on would not match.

  • This is case-sensitive, so /sent would not match a value of /Sent for a field like origin-folder-path.

Text Term Format

Text is a string sequence of characters that represent full-text values. Examples of this include file titles, descriptions, and comments. Fields of type text can be loosely matched, meaning a term like ‘File’ could match a text value of ‘File abc’ or “Document File”, etc.

Additional Notes

  • Nested quotation marks are not supported. For example: “Steven said “Nope””.

  • Single words in the ‘All text field’ not surrounded by quotes is considered a variable word. If you enter the word ‘test’ in the search bar with no quotes, you would get results that include, tested, testing, tests, etc.

Date Operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

Added to Onna

The date a file was added (or created) in Onna

onna-created-before: onna-created-after: onna-created-on-or-before: onna-created-on-or-after:

onna-created-on-or-before:03/01/2023

All Documents added to Onna on or before 03/01/2023

date

Creation Date

Original resource creation date. If unavailable, then from the embedded metadata. If both are unavailable, the date created in Onna.

created-before: created-after: created-on-or-before: created-on-or-after:

created-on-or-before:03/01/2023

All Documents created in origin on or before 03/01/2023

date

Deleted on

Date of when the resource was deleted in origin

source-deleted-before: source-deleted-after: source-deleted-on-or-before: source-deleted-on-or-after:

source-deleted-on-or-before:03/01/2023

All Documents deleted on or before 03/01/2023

date

Embedded file creation date

The file/resource creation date from embedded metadata within the document

embedded-created-before: embedded-created-after: embedded-created-on-or-before: embedded-created-on-or-after:

embedded-created-on-or-before:03/01/2023

All embedded documents created on or before 03/01/2023

date

Embedded file modification date

The file/resource modification date from embedded metadata within the document

embedded-modified-before: embedded-modified-after: embedded-modified-on-or-before: embedded-modified-on-or-after:

embedded-modified-on-or-before:03/01/2023

All embedded documents modified on or before 03/01/2023

date

Embedded printed date

The last printed date from embedded metadata within the document

embedded-printed-before: embedded-printed-after: embedded-printed-on-or-before: embedded-printed-on-or-after:

embedded-printed-on-or-before:03/01/2023

All embedded documents printed on or before 03/01/2023

date

Expiration date

The date and time that the object should become unpublished

expiration-before: expiration-after: expiration-on-or-before: expiration-on-or-after:

expiration-before:03/01/2023

All resources that were scheduled to be unpublished before 03/01/2023

date

Modification date

The last file modified date in origin. If unavailable, then from the embedded metadata. If both are unavailable, the date created in Onna.

modified-before: modified-after: modified-on-or-before: modified-on-or-after:

modified-on-or-before:03/01/2023

All Documents modified in origin on or before 03/01/2023

date

Modification date in Onna

The date a resource was last modified in Onna

onna-modified-before: onna-modified-after: onna-modified-on-or-before: onna-modified-on-or-after:

onna-modified-on-or-before:03/01/2023

All Documents modified in Onna on or before 03/01/2023

date

Processed date in Onna

Processing date of the resource in Onna; empty if not processed

onna-processed-before: onna-processed-after: onna-processed-on-or-before: onna-processed-on-or-after:

onna-processed-on-or-before: 03/01/2023

All Documents processed on or before 03/01/2023

date

Source created on

The date the record was created in the source

source-created-before: source-created-after: source-created-on-or-before: source-created-on-or-after:

source-created-on-or-before:03/01/2023

All Document created in a source on or before 03/01/2023

date

Email Operators

Important notes related to email operators

  • Characters supported for email operators include: numbers, letter, symbols, *, " "

    Field Display Name

    Meaning

    Syntax

    Example

    Results

    Term Format

    Email bcc

    List of email addresses of BCC recipients - the "BCC" (Blind Carbon Copy) field hides the listed recipients from other recipients, providing a discreet way to include additional individuals without revealing their identities

    bcc:

    bcc:[email protected]

    Returns results where the "bcc" recipient of an email was [email protected].

    text

    Email bcc name

    Email display names of BCC recipients - the blind carbon copy display name recipient(s) Example: John Doe

    bcc-name:

    bcc-name:support

    Returns all results where support is included as the display name of an email in the bcc field.

    text

    Email cc

    List of email addresses of CC recipients - the "CC" (Carbon Copy) field in an email includes additional recipients who should be informed or kept in the loop

    cc:

    cc:[email protected]

    Returns results where the "cc" recipient of an email was [email protected].

    text

    Email cc name

    Email display names of CC recipients - the carbon copy display name recipient(s) Example: John Doe

    cc-name:

    cc-name:support

    Returns all results where support is included as the display name of an email in the cc field.

    text

    Email from

    Email address of the sender of the email - the "From" field in an email identifies the sender or originator of the email, indicating who initiated the message

    from:

    from:[email protected]

    Returns results where the sender of an email was [email protected].

    text

    Email from name

    The 'from' email display name that sent the email Example: John Doe

    from-name:

    from-name:support

    Returns all results where support is included as the display name of an email in the from field.

    text

    Email ID

    Unique identifier for an email account - the unique message ID used to identify the email *Not available in Gmail

    email-id:

    email-id:1780939982307436399

    Returns all results where email id is '1780939982307436399'

    keyword

    Email subject

    The subject text of the sent email

    email-subject:

    email-subject:"best email"

    Searches the email subject field where the words best email (in that order) exist.

    text

    Email to

    Email address of the recipient(s) to whom the email is addressed - the "To" field in an email specifies the primary recipient(s) to whom the email is addressed

    to:

    to:[email protected]

    Returns results where the "to" recipient of an email was [email protected].

    text

    Email to name

    The 'to' display name recipient(s) Example: John Doe

    to-name:

    to-name:support

    Returns all results where support is included as the display name of an email in the to field.

    text

Metadata Operators

Important notes related to metadata operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

Application name

The name of the application that created the document, ie. Microsoft Excel, Word, etc.

application-name:

application-name:Excel

Returns all results where the application name contains 'Excel'.

text

Author

Name of the author of the resource in origin - the name of the person who created the file, if available

author:

author:Tammy

Returns all results where the author metadata field contains ' Tammy'.

text

Comments

The value associated with the document's comments field

onna-comments:

onna-comments:example

Returns all results where the onna comments contain 'example'.

text

Company

Company of record, extracted from metadata in the file from Microsoft Office Documents

company:

company:amazon

Returns all results where company field contains 'amazon'.

text

Conversation ID

Text identifier field used to identify a conversation

conversation-id:

conversation-id:12345

Returns all results where the conversation ID contains '12345'.

text

Conversation name

For conversations with a channel name, the channel name, otherwise a descriptor for the type of conversation

conversation-name:

conversation-name:meeting

Returns all results where the conversation name is 'meeting'.

text

Conversation type

Type of conversation in origin - categorizes the kind of conversation. For Slack this includes channels, groups (private channels), or DMs (direct messages). For Teams, channels or chat. Other examples: im, dms, mpim, groups, channels, chats (teams)

conversation-type:

conversation-type:DM

Returns all results where the conversation type contains 'DM'.

text

Detected language

The detected language used within the resource

language:

language:En

Returns all results where the language is 'English'. (Note: these are the ISO 639-1 format (2 letter))

keyword

Document UUID

Universally unique identifier assigned to a resource by Onna. (Sometimes referred to as document ID)

document-uuid:

document-uuid:33A74BKT3

Returns document with the UUID 33A74BKT3

keyword

Embedded author

The author from embedded metadata within the document

embedded-author:

embedded-author:"john doe"

Returns all results where the embedded author contains 'john doe'.

text

Embedded modified by

The last author from embedded metadata within the document

embedded-modified-by:

embedded-modified-by:"john smith"

Returns all results where the embedded modified field contains 'john smith'.

text

Extension

Resource file extension Example: .pdf, .jpg, .docx, etc.

extension:

extension:pdf

Returns all results where the extension contains 'pdf'.

text

Extracted text

The extracted text of the resource also known as the "full text" *limited to 10MB in length for search

extracted-text:

extracted-text:"gone fishing"

Returns all results where 'gone fishing' exists within the extracted text of a document.

text

File name

The file name of the resource

file-name:

file-name:somefile.txt

Returns all results where the file name is 'somefile.txt'.

text

File size

Size of the file/resource in bytes

less-than-file-size: greater-than-file-size: minimum-file-size: maximum-file-size:

less-than-file-size:100

Returns all results where the file size is less than 100 bytes.

long

File title

The title of the file from Microsoft Office Documents

title-microsoft-office:

title-microsoft-office:word

Returns all results where the title contains 'word'.

text

Folder path

Folder path in the source platform - Top Level Folder

origin-folder-path:

origin-folder-path:/folder

Returns all results where the origin folder path is '/folder' .

keyword (path)

List of users collected

Users associated with the collection process for the file

targeted-users:

targeted-users:[email protected]

Returns all results where the targeted user is '[email protected]'.

keyword

MD5 hash

The MD5 Hash of the resource

md5:

md5:abcdef1234567890

Returns all results where the MD5 hash is 'abcdef1234567890'.

keyword

Origin tag/label names

The tags associated with a document/resource from various sources. Example: Gmail labels

origin-tag:

origin-tag:important

Returns all results where the origin tag contains 'important'.

text

Parent creator name

The user name of the user who created the data source that the resource is a part of, if the data source was created under a user account

parent-creator-name:

parent-creator-name:"[email protected]"

Returns all results where the parent creator name is '[email protected]'.

text

Parent datasource ID

The database identifier of the parent datasource; appears in the url for the resource. Is unique in the path, but not unique across the database.

parent-datasource-id:

parent-datasource-id:12345

Returns all results where the parent datasource ID is '12345'.

keyword

Parent datasource title

The title of the resource's parent data source

parent-datasource-title:

parent-datasource-title:example

Returns all results where the parent datasource title contains 'example'.

text

Parent file type

The type of resource the parent file is to a child Example: if a child PDF file came from a zip, the parent content type would be zip

parent-file-type:

parent-file-type:zip

Returns all results where the parent file type is 'zip'.

keyword

Parent folder

The name of the parent folder for a resource in its native platform

parent-folder:

parent-folder:"/the_folder_b"

Returns all results where the parent folder contains '/the_folder_b'.

text

Parent source resource type

The file type of a resource's parent Examples: conversation/slack.channel or post/workplace

parent-origin-type:

parent-origin-type:conversation/slack.channel

Returns all results where the parent origin type is 'conversation/slack.channel'. All Available options: "ticket/github.issue" "ticket/github.pr" "ticket/zendesk" "ticket/generic" "conversation/slack.im" "conversation/slack.mpim" "conversation/slack.channel" "conversation/slack.group" "conversation/hangouts" "conversation/twitter" "conversation/emsteams" "post/workplace" "post/twitter" "channel/slack" "meeting/zoom.meeting" "meeting/zoom.instance" "meeting/zoom.chat" "meeting/zoom.transcript"

keyword

Parent title

The title of the resource's parent

parent-title:

parent-title:example

Returns all results where the parent title contains 'example'.

text

Parent user ID

The user id of the user who created the data source that the resource is a part of, if the data source was created under a user account

parent-user-id:

parent-user-id:12345

Returns all results where the parent user ID is '12345'.

keyword

Parent UUID

Unique identifier assigned to a parent file resource by Onna

parent-uuid:

parent-uuid:33A74BKT3

Returns parent document with the UUID 33A74BKT3

keyword

Parent workspace ID

The database identifier of the parent workspace; appears in the url for the resource. Is unique in the path, but not unique across the database.

parent-workspace-id:

parent-workspace-id:12345

Returns all results where the parent workspace ID is '12345'.

keyword

Parent workspace path

The database path to a workspace including “workspace” such that would be “workspace/workspace-name” by name here, the this means the database name, not title

parent-workspace-path:

parent-workspace-path:/path/to/workspace

Returns all results where the parent workspace path contans '/path/to/workspace'.

text

Parent workspace title

The title of the resource's parent workspace

parent-workspace-title:

parent-workspace-title:example

Returns all results where the parent workspace title is 'example'.

text

Parent workspace UUID

The unique database identifier of the parent workspace. It is unique across the database.

parent-workspace-uuid:

parent-workspace-uuid:abc123

Returns all results where the parent workspace UUID is 'abc123'.

keyword

Path to original file

The path to the original file in its native platform

origin-path:

origin-path:"/Onna/test/example/file_1.txt"

Returns all results where the origin path contains '/Onna/test/example/file_1.txt'.

text

Processing exception

The processing exception received if there is an exception generated during processing. Learn more about Onna Processing Exceptions

processing-exception:

processing-exception:"Download Error"

Returns all results where the processing exception contains "Download Error".

text

Related users emails

The active email addresses associated with the conversations/comments

related-users-email:

related-users-email:"[email protected]"

Returns all results where the related user email is '[email protected]'.

text

Related users names

The active user names associated with the conversations/comments and expanded users

related-users-name:

related-users-name:"John Doe"

Returns all results where the related user name contains 'John Doe'.

text

Resource creation size

Size of the file in bytes when the resource was created

less-than-creation-size: greater-than-creation-size: minimum-creation-size: maximum-creation-size:

less-than-creation-size:100

Returns all results where the creation size is less than 100 bytes

long

Source ID

The id of the record in the source platform

origin-id:

origin-id:56789

Returns all results where the origin ID is '56789'.

keyword

Source creator

User in Onna that created the source - the email address responsible for creating the source

onna-source-creator:

onna-source-creator:[email protected]

Returns all results where the onna source creator is '[email protected]'.

keyword

Source resource type

Categorizes the resource Example: Slack may include conversation/slack channel, ticket/zendesk

origin-resource-type:

origin-resource-type:conversation/slack channel

Returns all results where the origin resource type is 'conversation/slack channel'. Possible options for search terms using this operator include: • ticket/github.issue • ticket/github.pr • ticket/zendesk • ticket/genereic • conversation/slack.im • conversation/slack.mpim • conversation/slack.channel • conversation/slack.group • conversation/twitter • conversation/emsteams • post/workplace • post/twitter • channel/slack • meeting/zoom.meeting • meeting/zoom.instance • meeting/zoom.chat • meeting/zoom.transcript • slack/canvas • canvas/slack

keyword

Synced folder or label ID in source

Synchronization identifier in the source system - the folder or label where a resource is located. Examples include channel IDs where Slack conversations are located or folders within Dropbox or Google Drive.

origin-folder-id:

origin-folder-id:12345

Returns all results where the origin folder ID is '12345'.

keyword

Tag

Tag value associated with a resource

tag:

tag:important

Returns all results where the tag is 'important'.

keyword

Title

The brief and descriptive file name of a file/resource

title:

title:sometitle

Returns all results where the title contains 'sometitle'.

text

Type

The type of file assigned by Onna (e.g. image, conversation, document)

type:

type:image

Returns all results where the type is 'image'.

keyword

URL to original file

The URL to the file in it's origin platform

origin-url:

origin-url:http://example.com

Returns all results where the origin URL is 'http://example.com'.

keyword

All Text Fields

When searching across all text fields, the search is run against the following metadata fields:

When searching a keyword/phrase within the search bar, Onna runs the term against 40 metadata fields (see list below).


author, bcc_mail, bcc_mail_name, cc_mail, cc_mail_name, computed_title.keyword, computed_title.text_edge_ngram, computed_title^5, confluence_labels, contract_number, extension, extracted_text, extracted_text.text_edge_ngram, extracted_text.text_on_whitespace, extracted_text.text_stem, filename_ngram^5, from_mail, from_mail_name, from_mail.keyword, from_mail.text_edge_ngram_extended, id, md5_text, message_id, name, origin, origin_folder.path, origin_id, origin_label_ids, related_users, related_users_emails, related_users_names, related_users.email, related_users.email.keyword, related_users.id, related_users.name, related_users.name.keyword, related_users.user_types, space, space_name, thread_id, thread_name, thread_type, to_mail, to_mail_name, uuid, workspace_id, xtag_names

Parent Source Resource Term Options

  • "ticket/github.issue"

  • "ticket/github.pr"

  • "ticket/zendesk"

  • "ticket/generic"

  • "conversation/slack.im"

  • "conversation/slack.mpim"

  • "conversation/slack.channel"

  • "conversation/slack.group"

  • "conversation/hangouts"

  • "conversation/twitter"

  • "conversation/emsteams"

  • "post/workplace"

  • "post/twitter"

  • "channel/slack"

  • "meeting/zoom.meeting"

  • "meeting/zoom.instance"

  • "meeting/zoom.chat"

  • "meeting/zoom.transcript"

Source Resource Type Term Options

• ticket/github.issue

• ticket/github.pr

• ticket/zendesk

• ticket/genereic

• conversation/slack.im

• conversation/slack.mpim

• conversation/slack.channel

• conversation/slack.group

• conversation/twitter

• conversation/emsteams

• post/workplace

• post/twitter

• channel/slack

• meeting/zoom.meeting

• meeting/zoom.instance

• meeting/zoom.chat

• meeting/zoom.transcript

• slack/canvas

• canvas/slack

Type of Data Operators

Important notes related to type of data operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

(Special Operator) "<Keyword>" All text fields

Specific wording match (excluding special characters) - searches multiple fields for the given word or phrase.

""

"gone fishing"

Returns all results where the exact match 'gone fishing' is found in any of the following fields: author, bcc_mail, bcc_mail_name, cc_mail, cc_mail_name, computed_title.keyword, computed_title.text_edge_ngram, computed_title^5, confluence_labels, contract_number, extension, extracted_text, extracted_text.text_edge_ngram, extracted_text.text_on_whitespace, extracted_text.text_stem, filename_ngram^5, from_mail, from_mail_name, from_mail.keyword, from_mail.text_edge_ngram_extended, id, md5_text, message_id, name, origin, origin_folder.path, origin_id, origin_label_ids, related_users, related usersemails, related_users_names, related_users.email, related_uskeyword, related_users.id, related_users.name, related_users.name.keyword, related_users.user_types, space, space_name, thread_id, thread_name, thread_type, to_mail, to_mail_name, uuid, workspace_id, xtag_names

text

(Special Operator) @ Identity Identity

The unique identifiers associated with individuals or entities

@identity

@test.user@example.com

Returns all of the documents where '[email protected]' is a member in identity mapped sources

text

(Special Operator) In title

Title of the resource - computed title of the file; cleans up special characters within the file name

intitle:

intitle:"Help Article"

Returns all results where 'Help Article' is found in title.

text

(Special Operator) near: Word proximity

The spatial relationship between words or terms in a document (up to 3 terms distance)

near:

near:help,3,desk Note: The order in which you list terms will affect the results you get. For example: near:help,3,desk will search for situations where the term 'help' comes before the term 'desk'. However, near:desk,3,help will earch for situations where the term 'desk' comes before the term 'help'.

Returns all documents where 'help' is within 3 words of 'desk' this searches on the 'All text Fields' syntax.

text

(Special Operator) intext: In text

Indicates the presence of the term within the text, but not in the title

intext:

intext:example

Returns all results where 'example' is found in text and not the title.

text

Channel

The name of the channel where users can communicate, collaborate, and share information based on common topics, projects, or teams.

channel:

channel:marketing

Returns all results where the channel is 'marketing'.

keyword

Custom fields

User-created custom fields for additional metadata or information

cf-<custom-field>value:

cf-testing:example

Returns all results where the custom field 'testing' contains 'example'. Does not support is set/is not set.

text

Exact extracted text

Specific wording match (including special characters) - searches the extracted text for exact phrases including the special characters. Quotes are required to search the specific character.

exact-extracted-text:

exact-extracted-text:"Are you sure?"

Searches extracted text for 'are you sure?' which includes the '?'

Keyword

Has

Lists features or components that the resource possesses

has:

has:address has:attachment has:bank-number has:birthdate has:credit-card has:custom-field has:deletions has:editions has:pii has:reactions has:sensitive has:ssn has:tags

Returns all results that include the search term included. For example: has:address will return all resources that include an address.

boolean

Is

Specifies characteristics or attributes that apply to the resource

is:

is:archived is:attachment is:deleted is:favorite is:held is:shared is:nist

Returns all results that include the search term included. For example: is:favorite will return all resources that are a favorite in Onna.

boolean

Shared

The user whom the documents were shared with

shared:

shared:[email protected]

Results in all documents that have been shared with [email protected]

text

Source Specific Operators

Important notes related to source specific operators

Confluence Operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

Ancestors of file

The parent pages associated with the file/resource

confluence-ancestors:

confluence-ancestors:"Global Engineering"

Returns all results where the confluence ancestors contain 'Global Engineering'.

text

Labels

The list of label keywords associated with the space or file/resource

confluence-labels:

confluence-labels:Priority

Returns all results where the confluence labels contain 'Priority'.

text

Space ID

The text identifier field used to identify the space

confluence-space-id:

confluence-space-id:131074

Returns all results where the confluence space ID is '131074'.

keyword

Space name

The name of the space

confluence-space-name:

confluence-space-name:Workplace

Returns all results where the confluence space name contains 'Workplace'.

text

Space type

Specifies the type or category of the space

confluence-space-type:

confluence-space-type:personal

Returns all results where the confluence space type is 'personal'.

keyword

Jira Operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

Assignee email

The assignee who is currently the owner of the project/issue

jira-assignee-email:

jira-assignee-email:[email protected]

Returns all results where the Jira assignee email contains '[email protected]'.

text

Project name

The name of the project

jira-project-name:

jira-project-name:"Supply Chain Systems"

Returns all results where the Jira project name contains 'Supply Chain Systems'.

text

Project type

The type of the project to help categorize the project Examples: software, business, or service desk

jira-project-type:

jira-project-type:business

Returns all results where the Jira project type contains 'business'.

text

Thread ID

The text identifier field used to identify the project

jira-thread-id:

jira-thread-id:12345

Returns all results where the Jira thread ID is '12345'.

keyword

Quip Operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

List of folders

The folder id or name that a Quip document belongs to

quip-shared-folders:

quip-shared-folders:751236

Returns all results where the Quip shared folders are '751236'.

text

Slack Enterprise Operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

Workspace ID

The text identifier field used to identify the workspace

slack-workspace-id:

slack-workspace-id:L8PRZJKA5

Returns all results where the Slack workspace ID contains 'L8PRZJKA5'.

text

Workspace name

The name of the workspace in Slack

slack-workspace-name:

slack-workspace-name:"Unit testing"

Returns all results where the Slack workspace name contains 'Unit testing'.

text

Zendesk Operators

Field Display Name

Meaning

Syntax

Example

Results

Term Format

Ticket assignee

Individuals assigned to tasks related to the resource in origin

api-ticket-assignee:

api-ticket-assignee:Stephen

Returns all results where the API ticket assignee contains 'Stephen'

text

Ticket assignee group

The group the ticket is assigned to

api-ticket-assignee-group:

api-ticket-assignee-group:example

Returns all results where the API ticket assignee group contains 'example'.

text

Ticket category

The category that the ticket is classified as

api-ticket-category:

api-ticket-category:example

Returns all results where the API ticket category contains 'example'.

text

Ticket description

The section where the user ticket is described in detail

api-ticket-description:

api-ticket-description:example

Returns all results where the API ticket description contains 'example'.

text

Ticket followers

The followers of the ticket resource

api-ticket-follower:

api-ticket-follower:Stephen

Returns all results where the API ticket follower contains 'Stephen'

text

Ticket priority

The assigned priority of the ticket

api-ticket-priority:

api-ticket-priority:High

Returns all results where the API ticket priority contains 'High'.

text

Ticket reaction

The reactions added to a ticket

api-ticket-reaction:

api-ticket-reaction:liked

Returns all results where the API ticket reaction contains 'liked'

text

Ticket requester

The user who requested the ticket

api-ticket-requester:

api-ticket-requester:Kyle

Returns all results where the API ticket requester contains 'Kyle'.

text

Ticket severity

The ticket severity

api-ticket-severity:

api-ticket-severity:High

Returns all results where the API ticket severity contains 'High'.

text

Ticket subcategory

The subcategory that the ticket is classified as

api-ticket-subcategory:

api-ticket-subcategory:example

Returns all results where the API ticket subcategory contains 'example'.

text

Ticket tags

The list of tags associated to the ticket in the origin

api-ticket-tags:

api-ticket-tags:sample

Returns all results where the API ticket tags collected contains 'sample'

text

Ticket type

The assigned type of the ticket

api-ticket-type:

api-ticket-type:example

Returns all results where the API ticket type contains 'example'.

text

Ticket updater

The last user updated for the ticket

api-ticket-last-modified-by:

api-ticket-last-modified-by:Kyle

Returns all results where the API ticket last modified contains 'Kyle'.

text

API Ticket Operators

Important notes related to API ticket operators

  • These operators are only able to be used with ticket sources ingested through our platform API. For more information about other types of tickets see information related to our Zendesk operators.

Field Display Name

Meaning

Syntax

Example

Results

Term Format

Ticket assignee

Individuals assigned to tasks related to the resource in origin

api-ticket-assignee:

api-ticket-assignee:Stephen

Returns all results where the API ticket assignee contains 'Stephen'

text

Ticket assignee group

The group the ticket is assigned to

api-ticket-assignee-group:

api-ticket-assignee-group:example

Returns all results where the API ticket assignee group contains 'example'.

text

Ticket category

The category that the ticket is classified as

api-ticket-category:

api-ticket-category:example

Returns all results where the API ticket category contains 'example'.

text

Ticket description

The section where the user ticket is described in detail

api-ticket-description:

api-ticket-description:example

Returns all results where the API ticket description contains 'example'.

text

Ticket followers

The followers of the ticket resource

api-ticket-follower:

api-ticket-follower:Stephen

Returns all results where the API ticket follower contains 'Stephen'

text

Ticket priority

The assigned priority of the ticket

api-ticket-priority:

api-ticket-priority:High

Returns all results where the API ticket priority contains 'High'.

text

Ticket reaction

The reactions added to a ticket

api-ticket-reaction:

api-ticket-reaction:liked

Returns all results where the API ticket reaction contains 'liked'

text

Ticket requester

The user who requested the ticket

api-ticket-requester:

api-ticket-requester:Kyle

Returns all results where the API ticket requester contains 'Kyle'.

text

Ticket severity

The ticket severity

api-ticket-severity:

api-ticket-severity:High

Returns all results where the API ticket severity contains 'High'.

text

Ticket subcategory

The subcategory that the ticket is classified as

api-ticket-subcategory:

api-ticket-subcategory:example

Returns all results where the API ticket subcategory contains 'example'.

text

Ticket tags

The list of tags associated to the ticket in the origin

api-ticket-tags:

api-ticket-tags:sample

Returns all results where the API ticket tags collected contains 'sample'

text

Ticket type

The assigned type of the ticket

api-ticket-type:

api-ticket-type:example

Returns all results where the API ticket type contains 'example'.

text

Ticket updater

The last user updated for the ticket

api-ticket-last-modified-by:

api-ticket-last-modified-by:Kyle

Returns all results where the API ticket last modified contains 'Kyle'.

text


ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence