Skip to product menu
Skip to main content

Get Criteria of the Fields in Chat Routing Module

Description

You can use this API to populate the criteria of the fields available in the chat routing module.

OAuth Scope:

SalesIQ.criteriafields.READ

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

DatatypeComparator
region_optionsis_equal_to, not_equals
stringis_equal_to, begins_with, ends_with, contains, not_equals, not_contains
country_options is_equal_to, not_equals
visitor_infois_equal_to, between, greater_than, begins_with, ends_with, contains, not_equals
countis_equal_to, between, greater_than, less_than, not_equals
search_engine_optionsis_equal_to, not_equals
emailis_equal_to, not_equals, begins_with, ends_with, contains, not_contains

URL:

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

Example

Copiedhttps://salesiq.zoho.com/api/v2/zylker/criteriafields/chatrouting

Success Response

Copied{
  "url": "/api/v2/zylker/criteriafields/chatrouting",
  "object": "criteria_fields",
  "data": {
    "fields": [
      {
        "datatype": "string",
        "group_name": "website_values",
        "field_name": "current_page_title"
      },
      {
        "datatype": "string",
        "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": "website_values",
        "field_name": "search_engine"
      },
      {
        "datatype": "count",
        "group_name": "user_values",
        "field_name": "number_of_visits"
      },
      {
        "datatype": "count",
        "group_name": "general",
        "field_name": "number_of_past_chats"
      },
      {
        "datatype": "options",
        "group_name": "department",
        "field_name": "department"
      },
      {
        "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": "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": "string",
        "group_name": "based_on_chat",
        "field_name": "visitor_question"
      }
    ]
  }
}