Skip to product menu
Skip to main content

Get Criteria of the Fields in Intelligent Trigger Module

Description

You can use this API to populate the criteria of the fields available in the intelligent trigger module.

OAuth Scope: 

criteriafields.READ

You can use these datatypes and comparator populate your criteria of the fields. You can refer to the field name and values here.

Field NameComparatorValues
regionis_equal_to, not_equalssouth_america, north_america, canada, asia_pacific, united_kingdom, europe_middle_east_and_africa
triggered_actionis_equal_to, not_equalsopen_chat_window, animate_button, send_chat_invite, show_button, show_bubble, glow_button
refereris_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
landing_page_url is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
campaign_sourceis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
campaign_termis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
campaign_mediumis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
campaign_contentis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
utm_campaign_nameis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
emailis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
number_of_pages_browsedis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
landing_page_titleis, is_not, begins_with, ends_with, contains, not_contains 
visitor_email_updatedon, after, before 
countryis_equal_to, not_equalsPapua New Guinea, Combodia, Paraguay, Kazakhstan, Solomon Islands, Bahamas, Montserrat, Mali, Marshall Islands, Guadeloupe, Panama, Argentina, Isle Of Man, Seychelles, Zambia, Belize, South Georgia And The South Sandwich islands, Bahrain, Congo, Namibia, Comoros, Faroe Islands, Finland, Netherlands Antilles, Georgia, Yemen, Puerto Rico, Eritrea, Viet Nam, Madagascar, Aruba, Sweden, Malawi, Andorra, Liechtenstein, Poland, Bulgaria, Jordan, Tunisia, Tuvalu, United Arab Emirates, Kenya, French Polynesia, Lebanon, Djibouti, Azerbaijan, Cuba, Czech Republic, Saint Lucia, Mauritania, Guernsey, Timor-leste, Mayotte, Israel, San Marino, Australia, Tajikistan, Myanmar, Cameroon, Gibraltar, Cyprus, Northern Mariana Islands, Malaysia, Iceland, Oman, Bosnia And Herzegovina, Armenia, Gabon, Luxembourg, Brazil, Algeria, Jersey, Slovenia, Ecuador, Colombia, Moldova, Lao People's Democratic Republic, Cocos (keeling) Islands, Vanuatu, United States Minor Outlying Islands, Honduras, Italy, Antarctica, Nauru, Guinea-bissau, Haiti, Afghanistan, Russian Federation, Burundi, Singapore, French Guiana, American Samoa, Netherlands, China, Martinique, The Democratic Republic Of Congo, Kyrgyzstan, Wallis And Futuna, Saint Pierre And Miquelon, Reunion, Bhutan, Romania, Togo, Philippines, Uzbekistan, Pitcairn, British Virgin Islands, Zimbabwe, British Indian Ocean Territory, Montenegro, Indonesia, Dominica, Benin, Angola, Sudan, Brunei Darussalam, Portugal, New Caledonia, North Korea, Grenada, Greece, Cayman Islands, Mongolia, Latvia, Iran, Morocco, Guatemala, Guyana, Iraq, Cote D'ivoire, Chile, Holy See (vatican City State), Nepal, Ukraine, Tanzania, Ghana, Saint Vincent And The Grenadines, Anguilla, India, Canada, Maldives, Turkey, Belgium, Taiwan, South Africa, Bermuda, Aland Islands, Jamaica, Peru, Turkmenistan, Germany, Fiji, Tokelau, Hong Kong, United States, Guinea, Somalia, Chad, Thailand, Equatorial Guinea, Kiribati, Costa Rica, Falkland Islands (malvinas), Kuwait, Nigeria, Croatia, Sao Tome And Principe, Syrian Arab Republic, Uruguay, Sri Lanka, Cook Islands, United Kingdom, Switzerland, Samoa, Palestine, Spain, Venezuela, Liberia, Burkina Faso, Swaziland, Palau, Turks And Caicos Islands, Estonia, Christmas island, Libyan Arab Jamahiriya, Niue, Svalbard And Jan Mayen, South Korea, Austria, Mozambique, El Salvador, Monaco, Guam, Central african republic, Lesotho, Tonga, Heard Island And Mcdonald Islands, Western Sahara, Hungary, Europe, Japan, Curacao, Belarus, Mauritius, Bouvet Island, Norfolk Island, Trinidad And Tobago, Albania, New Zealand, Senegal, Macedonia, Ethiopia, Egypt, Sierra Leone, Bolivia, Malta, Saudi Arabia, Cape Verde, Pakistan, Gambia, Qatar, Ireland, U.S. Virgin Islands, Slovakia, Lithuania, Serbia, France, Niger, Rwanda, Saint Kitts And Nevis, French Southern Territories, Bangladesh, Barbados, Nicaragua, Norway, Botswana, Macao, Dominican Republic, Denmark, Mexico, Uganda, Suriname, Micronesia, Saint Helena, Greenland, Antigua And Barbuda)
visitor_infois_equal_to, between, greater_than, begins_with, ends_with, contains, not_equals 
time_on_sitegreater_than, less_than, is_equal_to, not_equals, between 
actions_performedis, is_notcontacted, bot_transfer_missed, missed, clicked, chat_completed, triggered_replied, email_updated
visitor_typeis_equal_to, not_equalsall, new, returning
browseris_equal_to, not_equals

opera, google_chrome, apple_safari, mozilla_firefox, microsoft_internet_explorer,unknown

operating_systemis_equal_to, not_equalsnokia, apple_ipad, sun_solaris, microsoft_windows, web_os, nintendo,  apple_macintosh, apple_iphone, android, symbian, playstation,  blackberry, linux, motorola, kindle
search_engineis_equal_to, not_equalsteoma, inktomi, yahoo, webcrawler, baidu, google, bing
cityis_equal_to, not_equals 
stateis_equal_to, not_equals 
current_visit_sourceis_equal_to, not_equalsreferral, adwords, direct,  campaign, search_engine, social_media
first_visit_sourceis_equal_to, not_equals 
custom_actionis_equal_to, not_equals 
number_of_visitsis_equal_to, between, greater_than, less_than, not_equals 
number_of_past_chatsis_equal_to, between, greater_than, less_than, not_equals 
number_of_pages_accessedis_equal_to, between, greater_than, less_than, not_equals 
ip_addressis_equal_to, between 
previous_page_urlis, is_not, begins_with, ends_with, contains, not_contain 
current_page_urlis, is_not, begins_with, ends_with, contains, not_contains 
triggered_statusis_equal_to, not_equals 
current_page_titleis_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches 
departmentis_equal_to, not_equals 
last_action_performedis_equal_to, not_equals 
visitor_availabilityis_equal_to, not_equals 
leadscore

is_equal_to, between, greater_than, less_than, not_equals

 

URL:

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/criteriafields/triggerrules

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylkerinc/criteriafields/trigger

Sample Response

Copied{
  "url": "/web/v2/jegan_portal/criteriafields/trigger",
  "object": "criteria_fields",
  "data": {
    "fields": [
      {
        "datatype": "seconds",
        "group_name": "user_values",
        "field_name": "time_on_site"
      },
      {
        "datatype": "page_title",
        "group_name": "website_values",
        "field_name": "current_page_title"
      },
      {
        "datatype": "page_url",
        "group_name": "website_values",
        "field_name": "current_page_url"
      },
      {
        "datatype": "string",
        "group_name": "website_values",
        "field_name": "referer"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "country"
      },
      {
        "datatype": "options",
        "group_name": "technology",
        "field_name": "browser"
      },
      {
        "datatype": "options",
        "group_name": "technology",
        "field_name": "operating_system"
      },
      {
        "datatype": "options",
        "group_name": "website_values",
        "field_name": "search_engine"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "visitor_availability"
      },
      {
        "datatype": "count",
        "group_name": "user_values",
        "field_name": "number_of_visits"
      },
      {
        "datatype": "count",
        "group_name": "general",
        "field_name": "number_of_past_chats"
      },
      {
        "datatype": "count",
        "group_name": "website_values",
        "field_name": "number_of_pages_accessed"
      },
      {
        "datatype": "ip_address",
        "group_name": "user_values",
        "field_name": "ip_address"
      },
      {
        "datatype": "options",
        "group_name": "department",
        "field_name": "department"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "last_action_performed"
      },
      {
        "datatype": "string",
        "group_name": "website_values",
        "field_name": "landing_page_url"
      },
      {
        "datatype": "string",
        "group_name": "website_values",
        "field_name": "landing_page_title"
      },
      {
        "datatype": "visitor_info",
        "group_name": "user_values",
        "field_name": "visitor_info"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "region"
      },
      {
        "datatype": "string",
        "group_name": "utm_values",
        "field_name": "campaign_source"
      },
      {
        "datatype": "string",
        "group_name": "utm_values",
        "field_name": "campaign_term"
      },
      {
        "datatype": "string",
        "group_name": "utm_values",
        "field_name": "campaign_medium"
      },
      {
        "datatype": "string",
        "group_name": "utm_values",
        "field_name": "campaign_content"
      },
      {
        "datatype": "string",
        "group_name": "utm_values",
        "field_name": "utm_campaign_name"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "city"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "state"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "visitor_type"
      },
      {
        "datatype": "page_url",
        "group_name": "website_values",
        "field_name": "previous_page_url"
      },
      {
        "datatype": "options",
        "group_name": "triggered_status",
        "field_name": "triggered_status"
      },
      {
        "datatype": "options",
        "group_name": "website_values",
        "field_name": "current_visit_source"
      },
      {
        "datatype": "string",
        "group_name": "user_values",
        "field_name": "email"
      },
      {
        "datatype": "options",
        "group_name": "website_values",
        "field_name": "first_visit_source"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "actions_performed"
      },
      {
        "datatype": "count",
        "group_name": "user_values",
        "field_name": "leadscore"
      }
    ]
  }
}