Get Criteria of the Fields in Lead Scoring Module

Description

You can use this API to populate the criteria of the fields available in the lead scoring 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.

Datatype	Comparator
region_options	is_equal_to, not_equals
triggered_action_options	is_equal_to, not_equals
string	is_equal_to, begins_with, ends_with, contains, not_equals, not_contains, matches, not_matches
country_options	is_equal_to, not_equals
visitor_info	is_equal_to, between, greater_than, begins_with, ends_with, contains, not_equals
seconds	greater_than, less_than, is_equal_to, not_equals, between
actions_performed_options	is, is_not
visitor_type_options	is_equal_to, not_equals
email	is, is_not, begins_with, ends_with, contains, not_equals
count	is_equal_to, between, greater_than, less_than, not_equals
operating_system_options	is_equal_to, not_equals
ip_address	is_equal_to, between
browser_options	is_equal_to, not_equals
custom_action_performed	is, is_not, is_unknown, has_any_value, contains, not_contains
search_engine_options	is_equal_to, not_equals

URL:

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

Example

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

Sample Response

Copied{
  "url": "/api/v2/zylker/criteriafields/leadscore",
  "object": "criteria_fields",
  "data": {
    "fields": [
      {
        "datatype": "seconds",
        "group_name": "user_values",
        "field_name": "time_on_site"
      },
      {
        "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": "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": "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": "email_updated",
        "group_name": "general",
        "field_name": "visitor_email_updated"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "actions_performed"
      },
      {
        "datatype": "options",
        "group_name": "general",
        "field_name": "triggered_action"
      },
      {
        "datatype": "options",
        "group_name": "user_values",
        "field_name": "custom_action"
      },
      {
        "datatype": "string",
        "group_name": "general",
        "field_name": "number_of_pages_browsed"
      }
    ]
  }
}