Get a specific Webform A/B Testing
Purpose
To retrieve the details of a specific Webform A/B Testing created for Webforms in your Zoho CRM organization. You can optionally filter the results based on the module of the webform.
Endpoints
- GET /settings/AB_testing/{AB_testing_ID}
Request Details
Request URL
{api-domain}/crm/{version}/settings/AB_testing/{AB_testing_ID}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.settings.abtest.ALL
(or)
ZohoCRM.settings.abtest.READ
Parameters
- modulestring, mandatory
To filter Webform A/B Testing by the API name of the module for which the webform A/B testing configurations are created (for example, Leads).
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/AB_testing/4794410000000772022?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GETResponse JSON
The root key AB_testing is a JSON array containing a single object with the details of the requested A/B Testing. The object has the following keys:
- id string
Unique identifier of the A/B Testing.
- name string
Name of the A/B Testing.
- status string
Current lifecycle status of the A/B Testing.
Possible values:
- drafted: A preliminary configuration that has not yet been executed.
- scheduled: Scheduled to start at a future time.
- running: Currently in progress.
- paused: Temporarily on hold. While paused, the original (base) webform is served to all visitors.
- completed: The test has finished running.
- launched: A winning webform has been launched to replace the original.
- traffic integer
Overall percentage of visitors included in the A/B Testing.
- notify Boolean
Indicates whether an email notification will be sent to the user who created the A/B Testing (returned in created_by) with the winner details, once the test is completed.
- dynamic_allocation_by_zia Boolean
Indicates whether traffic is dynamically allocated based on form performance by Zia. When enabled, the system increases visitor allocation to better-performing variations during the test.
- created_time datetime
Date and time when the A/B Testing was created (ISO 8601).
- created_by JSON object
User who created the A/B Testing.
- id string
Unique ID of the user.
- name string
Display name of the user.
- module JSON object
CRM module the A/B Testing is configured for.
- id string
Unique ID of the module.
- api_name string
API name of the module (for example, Leads).
- base_form JSON object
Base (original) webform used in the A/B Testing.
- id string
Unique ID of the base webform.
- name string
Name of the base webform.
- traffic integer
Percentage of test traffic allocated to the base webform.
- winner Boolean
Indicates whether the base webform is the current winner of the A/B Testing.
- old_traffic integer
Previous traffic allocation (before the latest Zia dynamic reallocation). null if traffic has not been reallocated.
- winner_confidence JSON object
Confidence metadata generated by Zia during winner evaluation for the base webform. null when Zia has not yet computed a confidence value.
- variant_form JSON array
Variant webforms configured for this A/B Testing. Each variant object has the following keys:
- id string
Unique ID of the variant webform.
- name string
Name of the variant webform.
- traffic integer
Percentage of test traffic allocated to this variant.
- winner Boolean
Indicates whether this variant is the current winner.
- old_traffic integer
Previous traffic allocation for this variant, before Zia dynamic reallocation. null if traffic has not been reallocated.
- winner_confidence JSON object
Confidence metadata generated by Zia during winner evaluation for this variant.
- encrypted_form_id string
Encrypted identifier used to uniquely and securely reference this webform instance when embedded on a web page.
- tracking_code string
HTML/script snippet embedded on the host web page to track visits and conversions for this variant.
- form_attributes JSON object
Visual and layout attributes of the variant.
- color string
Background color of the form.
- width integer
Width of the form in pixels.
- display_form_name Boolean
Whether the form name is displayed on the webform.
- align string
Alignment of the form on the web page.
- font_attributes JSON object
Font styling for the form.
- size integer
Font size.
- color string
Font color.
- family string
Font family.
- button_attributes JSON array
Action buttons on the variant. Each button object has the following keys:
- name string
Button label (for example, Submit, Reset).
- color string
Button color.
- form_fields JSON array
Fields configured for this variant webform. Each field object has the following keys:
- type string
Field category.
Possible values:
- general: A standard CRM field mapped from the module layout.
- advanced: A special field such as file_upload, standard_captcha, or privacy_policy.
- portal: A field sourced from the associated portal configuration.
- field JSON object
CRM field mapping (for general and portal fields).
- api_name string
API name of the CRM field.
- field_label string
Label shown on the webform.
- id string
Unique ID of the CRM field.
- field_info JSON object
Metadata for advanced fields (for example, file_upload, standard_captcha, privacy_policy). Includes type, field_label, and type-specific keys such as privacy_value.
- field_name string
Internal name for the field on the webform (may differ from the CRM API name for custom fields).
- display_label string
Label displayed on the webform (used for advanced fields).
- hidden Boolean
Whether the field is hidden from the user.
- required Boolean
Whether the field is mandatory for submission.
- date_format string
Date format for date-type fields (for example, DD/MM/YYYY).
- default_value string
Default value for hidden fields.
- help JSON object
Help text/link shown near the field.
- text string
Help text displayed next to the field.
- url string
Optional URL linked from the help text.
- condition JSON object
Test-end criteria that determine when the A/B Testing stops.
- type string
The type of end condition. Possible values: duration, range, visits.
- period string
When type is duration, the unit of time. Possible values: days, weeks, months.
- unit integer
When type is duration, the number of periods for which the test runs. When type is visits, the total number of visitors after which the test ends.
- from datetime
When type is range, the start date/time of the test.
- to datetime
When type is range, the end date/time of the test.
- remaining integer
The number of periods (or visitors) remaining before the test ends.
- winner_configuration JSON object
Configuration that controls how the winner is handled once the test ends.
- announce_automatically Boolean
Whether the winning webform is automatically launched once the test is completed.
- conversion_percentage_difference integer
Minimum conversion rate a variant must achieve to be eligible for automatic launch (returned when configured via the "Based on Condition" option).
- pause_resume_info JSON array
History of pause/resume events for this A/B Testing. Each object has the following keys:
- pause datetime
Date/time when the test was paused.
- resume datetime
Date/time when the test was resumed.
- traffic_diversion JSON object
Details of the current traffic distribution across the base and variant webforms when advanced traffic diversion is in effect (for example, after Zia has dynamically reallocated traffic during a running test). Returns null when no diversion has been applied.
- complete_restart_info JSON object
Metadata about a restarted A/B Testing. If a completed A/B Testing has been restarted, this object holds information linking the current test to its previous run. Returns null when the test has not been restarted.
- suggestion JSON object
Zia-generated suggestion for the A/B Testing (for example, to extend the test duration or to launch the current leader with a specified confidence level). Returns null when no suggestion is available.
Note
The following keys are returned only by this endpoint (retrieving a specific A/B Testing) and are not returned when listing all Webform A/B Testing configurations:
- form_fields, form_attributes, button_attributes, encrypted_form_id, and tracking_code inside each variant_form object.
- winner_confidence inside base_form and each variant_form object.
- pause_resume_info at the root level.
Sample Response
Copied{
"AB_testing": [
{
"created_time": "2026-01-11T18:40:29+05:30",
"dynamic_allocation_by_zia": false,
"complete_restart_info": null,
"module": {
"api_name": "Leads",
"id": "4794410000000000125"
},
"suggestion": null,
"base_form": {
"winner": false,
"old_traffic": null,
"name": "newwebform",
"id": "4794410000000765145",
"winner_confidence": null,
"traffic": 34
},
"created_by": {
"name": "Patricia Boyle",
"id": "4794410000000642001"
},
"notify": false,
"traffic_diversion": null,
"condition": {
"unit": 30,
"period": "days",
"type": "duration",
"remaining": 29
},
"variant_form": [
{
"encrypted_form_id": "cce622a7994ff023e713f9f81127e17137e57d95dc42967c18b06438a721542f20ec1b7157cc511f5bee9edba70c41df",
"form_fields": [
{
"help": null,
"hidden": false,
"field": {
"api_name": "Company",
"field_label": "Company",
"id": "4794410000000000555"
},
"date_format": null,
"type": "general",
"required": true,
"field_name": "Company"
},
{
"help": null,
"hidden": false,
"field": {
"api_name": "Date_1",
"field_label": "Date 1",
"id": "4794410000000755001"
},
"date_format": "DD/MM/YYYY",
"type": "general",
"required": false,
"field_name": "LEADCF116"
},
{
"help": null,
"hidden": false,
"field": {
"api_name": "Last_Name",
"field_label": "Last Name",
"id": "4794410000000000559"
},
"date_format": null,
"type": "general",
"required": true,
"field_name": "Last Name"
},
{
"help": null,
"hidden": false,
"field": {
"api_name": "Email",
"field_label": "Email",
"id": "4794410000000000563"
},
"date_format": null,
"type": "general",
"required": true,
"field_name": "Email"
},
{
"display_label": "Upload a File",
"help": null,
"hidden": false,
"type": "advanced",
"required": false,
"field_info": {
"field_label": "Upload a File",
"type": "file_upload"
}
},
{
"display_label": "Privacy Policy",
"help": null,
"hidden": false,
"type": "advanced",
"required": false,
"field_info": {
"field_label": "Privacy Policy",
"privacy_value": "<div style='font-family:Verdana, arial, Helvetica, sans-serif'>I agree to the Privacy Policy and Terms of Service</div>",
"type": "privacy_policy"
}
}
],
"winner": false,
"old_traffic": null,
"name": "newwebform",
"button_attributes": [
{
"color": "#fff",
"name": "Submit"
},
{
"color": "#fff",
"name": "Reset"
}
],
"id": "4794410000000772023",
"form_attributes": {
"color": "white",
"width": 600,
"font_attributes": {
"size": 12,
"color": "black",
"family": "Arial"
},
"display_form_name": true,
"align": "left"
},
"tracking_code": "<!-- Do not remove this --- Analytics Tracking code starts --><script id='wf_anal' src='https://crm.zoho.com/crm/WebFormAnalyticsServeServlet?rid=0c0d4af1486ac1c74ebdb5295baed0f54c01e90797703b442222ac80605992e881f2e2d7a0e085490cf345b4b257c340gid7d40ec99e1cf27718e1d3bf90985a078ef6ea5f122c10efbc1d084d725c2aaa7gid6dbb733f5c70f23b037526abbc9474000ee58fb5023b8b5cf19d9c96b677338cgid9f03ee98789ab0c73424452a8d045dec71266911f7885e7ee848d6087dfedcd8gid3d44d43db8b0126260e7b0b06674e195561f596e6a2985f9f78c08c963868ab66f70226c591555c105fec585ae583018&tw=0eb2e165a451dc8cc1087a3ca585f04d7a70ab10a5401bd9428ae9e930dc0b8c'></script><!-- Do not remove this --- Analytics Tracking code ends. -->",
"winner_confidence": null,
"traffic": 33
},
{
"encrypted_form_id": "7a61723794cad333f82603b0087411d962d4ce59851b27bcbf84205c950d0463c51a3de88069250667fd6bbeb3de521c",
"form_fields": [
{
"help": null,
"hidden": false,
"field": {
"api_name": "Company",
"field_label": "Company",
"id": "4794410000000000555"
},
"date_format": null,
"type": "general",
"required": true,
"field_name": "Company"
},
{
"help": null,
"hidden": false,
"field": {
"api_name": "Last_Name",
"field_label": "Last Name",
"id": "4794410000000000559"
},
"date_format": null,
"type": "general",
"required": true,
"field_name": "Last Name"
},
{
"help": null,
"hidden": false,
"field": {
"api_name": "Date_1",
"field_label": "Date 1",
"id": "4794410000000755001"
},
"date_format": "DD/MM/YYYY",
"type": "general",
"required": false,
"field_name": "LEADCF116"
},
{
"help": null,
"hidden": true,
"field": {
"api_name": "Single_Line_1",
"field_label": "Single Line 1",
"id": "4794410000000755018"
},
"date_format": null,
"default_value": "hidden",
"type": "general",
"required": false,
"field_name": "LEADCF1"
},
{
"display_label": "Enter the Captcha",
"help": null,
"hidden": false,
"type": "advanced",
"required": false,
"field_info": {
"field_label": "Enter the Captcha",
"type": "standard_captcha"
}
},
{
"display_label": "Upload a File",
"help": null,
"hidden": false,
"type": "advanced",
"required": false,
"field_info": {
"field_label": "Upload a File",
"type": "file_upload"
}
},
{
"display_label": "Privacy Policy",
"help": null,
"hidden": false,
"type": "advanced",
"required": false,
"field_info": {
"field_label": "Privacy Policy",
"privacy_value": "<div style='font-family:Verdana, arial, Helvetica, sans-serif'>I agree to the Privacy Policy and Terms of Service</div>",
"type": "privacy_policy"
}
}
],
"winner": false,
"old_traffic": null,
"name": "newwebform",
"button_attributes": [
{
"color": "#fff",
"name": "Submit"
},
{
"color": "#fff",
"name": "Reset"
}
],
"id": "4794410000000772024",
"form_attributes": {
"color": "white",
"width": 600,
"font_attributes": {
"size": 12,
"color": "black",
"family": "Arial"
},
"display_form_name": true,
"align": "left"
},
"tracking_code": "<!-- Do not remove this --- Analytics Tracking code starts --><script id='wf_anal' src='https://crm.zoho.com/crm/WebFormAnalyticsServeServlet?rid=90d3df0189c2820a374d3f527b3365dc1caa19bgid839b18c98fea081663c1d942513f5e5a36387c016b7bf282a3f3c927f5271658gid2855d8b7ac6e97d2034a61cca819458d500626913b459abf9303a5c0a931d285gid657512c968452fd1518cb2626d21d5dc9ababc514280d86acfe2445cd4f718bagid066f3bc4ea5e0a061747942d10d7218aad9def7821eba598a0f2441f509d5b0f030e86897282e06a4a1cfafce4b988ed&tw=b1c06d670565309dd3aaab806ec3e55b33d66e4de48acaa4e032d56d00841398'></script><!-- Do not remove this --- Analytics Tracking code ends. -->",
"winner_confidence": null,
"traffic": 33
}
],
"pause_resume_info": [
{
"resume": "2026-01-11T19:29:20+05:30",
"pause": "2026-01-11T19:28:39+05:30"
},
{
"resume": "2026-01-11T19:29:46+05:30",
"pause": "2026-01-11T19:29:42+05:30"
}
],
"name": "new",
"winner_configuration": {
"announce_automatically": false
},
"id": "4794410000000772022",
"status": "running",
"traffic": 100
}
]
}Possible Errors
- INVALID_DATAHTTP 400
The module name given seems to be invalid.
Resolution: Specify a valid module name for the parameter: module. - REQUIRED_PARAM_MISSINGHTTP 400
One of the expected parameter is missing.
Resolution: Specify the mandatory parameter module. - NO_PERMISSIONHTTP 403
Permission denied.
Resolution: You do not have permission to perform this action. Only users with Webforms ABtesting permission can perform this action.