Create a Visitor History View

Description

You can use this API to create a visitor history view.

Requested Payload:

and_criteria (Mandatory) - To add more than one condition and criteria to the rule.
- or_criteria : Specifies a set of criteria containing the comparator, values and fieldname ie., you can provide more than one criteria and the rule will execute if the visitor matches any of the given criteria.
  - field_name : Fields that you set to filter the visitor who matches the rule.
  - sub_field: The sub field that you set to filter the visitor who matches the rule.
  - comparator : The comparator strings for that specific rule you have set is used to match the values (eg: contains, is_equal_to, etc.)
  - values : The values that you have defined for each field that the visitor should obtain to match the rule.
  - integ_name : The name of the integration.
name (Mandatory) - To name the visitor history list view.
sort_by - To sort the visitor history list based on the default options.( Values: frequency, leadscore, last_visit_time, time_on_site)
favourited - To mark the visitor history list as your favourite.

OAuth Scope:

visitorhistoryviews.CREATE

Field Name	Comparator	Values
region	is_equal_to, not_equals	south_america, north_america, canada, asia_pacific, united_kingdom, europe_middle_east_and_africa
operating_system	is_equal_to, not_equals	nokia, apple_ipad, sun_solaris, microsoft_windows, web_os, nintendo, apple_macintosh, apple_iphone, android, symbian, playstation, blackberry, linux, motorola, kindle
landing_page_url	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_source	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_term	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_medium	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
campaign_content	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
utm_campaign_name	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
email	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
landing_page_title	is, is_not, begins_with, ends_with, contains, not_contains
country	is_equal_to, not_equals	Papua 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_info	is_equal_to, between, greater_than, begins_with, ends_with, contains, not_equals
visitor_type	is_equal_to, not_equals	all, new, returning
browser	is_equal_to, not_equals	opera, google_chrome, apple_safari, mozilla_firefox, microsoft_internet_explorer,unknown
last_visit_duration	is_equal_to, between, greater_than, less_than, not_equals
city	is_equal_to, not_equals
state	is_equal_to, not_equals
last_visit_source	is_equal_to, not_equals	AdWords, Campaign, Direct, Referral, Search Engine, Social Media,
leadscore	is_equal_to, between, greater_than, less_than, not_equals
number_of_visits	is_equal_to, between, greater_than, less_than, not_equals
number_of_past_chats	is_equal_to, between, greater_than, less_than, not_equals
last_visited_time	is_equal_to, between, greater_than, less_than, not_equals
visitor_source	is_equal_to, not_equals	AdWords, Campaign, Direct, Referral, Search Engine, Social Media

URL:

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screenname}/visitorhistoryviews

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylker/visitorhistoryviews

Payload

Copied{
    "and_criteria": [
      {
        "or_criteria": [
          {
            "comparator": "is_equal_to",
            "values": [
              "apple_safari"
            ],
            "field_name": "browser"
          },
{
              "comparator": "is_equal_to",
              "sub_field": "No of Open Deals",
              "values": [
                  "12"
              ],
              "field_name": "crm_deal",
              "integ_name": "zohocrm"
          }
        ]
      }
    ],
    "favourited": true,
    "name": "safari_view"
}

Sample Response

Copied{
  "url": "/api/v2/zylker/visitorhistoryviews",
  "object": "visitorhistoryview",
  "data": {
    "and_criteria": [
      {
        "or_criteria": [
          {
            "comparator": "is_equal_to",
            "values": [
              "apple_safari"
            ],
            "field_name": "browser"
          },
{
              "comparator": "is_equal_to",
              "sub_field": "No of Open Deals",
              "values": [
                  "12"
              ],
              "field_name": "crm_deal",
              "integ_name": "zohocrm"
          }
        ]
      }
    ],
"system": false,
    "favourited": true,
    "name": "safari_view",
    "creator": {
      "id": "66000000000005"
    },
    "sort_by": "leadscore",
    "modified_time": 1555917442819,
    "id": "66000000011001"
  }
}