AutoML What If Analysis

Generate predictions using a trained AutoML model.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/automl/workspaces/<workspace-id>/analysis/<analysis-id>/models/<model-id>/whatif

Post

oauthscope: ZohoAnalytics.modeling.create

QUERY PARAMETERS

 

Parameter Name		Description
CONFIGJSONObject

Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

KeyDescription
features *

JSONObject

Key‑value pairs of feature inputs for What‑If analysis. Each key is a feature/column name and each value is the test value used to generate predictions.

Sample:
{ "Sales": "1000", "Region": "East", "Product Category": "Stationery" }

STRUCTURE FOR FEATURES CONFIG

KeyDescription
<columnName> *

String

Name of the feature/column from the training dataset.

Value: Hypothetical value to be used for What‑If analysis for the specified feature.

Sample Request:

CurlDelugeCsharpGoJavaPHPPythonNode JSRuby
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/automl/workspaces/<workspace-id>/analysis/<analysis-id>/models/<model-id>/whatif --data-urlencode 'CONFIG={"features":{"Sales":"1000","Region":"East","Product Category":"Stationery"}}'
-X 'POST'
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'
CopiedorgId = "55522777";
workspaceId = "<workspace-id>";
analysisId = "<analysis-id>";
modelId = "<model-id>";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID", orgId);

config = Map();

featuresMap = Map();
featuresMap.put("Sales", "1000");
featuresMap.put("Region", "East");
featuresMap.put("Product Category", "Stationery");
config.put("features", featuresMap);

paramsMap = Map();
paramsMap.put("CONFIG", config.toString());

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/automl/workspaces/" + workspaceId + "/analysis/" + analysisId + "/models/" + modelId + "/whatif"
  type :POST
  parameters:paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];

info response;
Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;
using System.Text.Json;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;

        public void AutomlAnalysisPrediction(IAnalyticsClient ac)
        {
            long analysisId = 466206000000197001;
            long modelId = 466206000000197003;

            Dictionary<string, object> features = new Dictionary<string, object>
            {
                { "Sales", 1000 },
                { "Region", "East" },
                { "Product Category", "Stationery" }
            };

            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);

            JsonElement predictionResult =
                workspace.AutomlAnalysisPrediction(
                    analysisId,
                    modelId,
                    features,
                    null
                );

            Console.WriteLine(predictionResult.ToString());
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.AutomlAnalysisPrediction(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}
Copiedpackage main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var (
    clientId     = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId       = "55522777"
    workspaceId = "35130000001055707"
)

func AutoMLAnalysisPrediction(ac ZAnalytics.Client) {
    analysisID := "466206000000073001"
    modelID := "466206000000073003"

    features := map[string]interface{}{
        "Sales":            1000,
        "Region":           "East",
        "Product Category": "Stationery",
    }

    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)

    predictionResult, exception := workspace.AutoMLAnalysisPrediction(
        analysisID,
        modelID,
        features,
        nil,
    )

    if exception != nil {
        fmt.Println("Error:", exception)
        return
    }

    fmt.Println("Prediction Result:")
    fmt.Println(predictionResult)
}

func main() {
    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    AutoMLAnalysisPrediction(ac)
}
Copiedimport com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;

    public static void main(String args[]) {

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.autoMLPrediction(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode()
                    + ", ErrorMessage : " + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : " + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void autoMLPrediction(AnalyticsClient ac) throws Exception {

        String analysisId = "466206000000182001";
        String modelId = "466206000000182005";

        JSONObject features = new JSONObject();
        features.put("Sales", 1000);
        features.put("Region", "East");
        features.put("Product Category", "Stationery");

        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);

        JSONObject predictionResult = workspace.autoMLAnalysisPrediction(
                analysisId,
                modelId,
                features,
                null
        );

        System.out.println("Prediction Result : " + predictionResult);
    }
}
Copied<?php

require 'AnalyticsClient.php';

class Test
{
    public $ac = NULL;
    public $client_id = "1000.xxxxxxx";
    public $client_secret = "xxxxxxx";
    public $refresh_token = "1000.xxxxxxx.xxxxxxx";

    public $org_id = "55522777";
    public $workspace_id = "35130000001055707";

    function __construct() {
        $this->ac = new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
    }

    function autoMLAnalysisPrediction() {
        $analysis_id = "466206000000126001";
        $model_id = "466206000000126003";

        $features = array(
            "Sales" => 1000,
            "Region" => "East",
            "Product Category" => "Stationery"
        );

        $workspace = $this->ac->getWorkspaceInstance(
            $this->org_id,
            $this->workspace_id
        );

        $prediction_result = $workspace->autoMLAnalysisPrediction(
            $analysis_id,
            $model_id,
            $features
        );

        echo "Prediction Result:\n";
        print_r($prediction_result);
    }
}

$test_obj = new Test();

try {
    $test_obj->autoMLAnalysisPrediction();
}
catch(ServerException $se) {
    echo "Server exception : " . $se->getErrorMessage() . "\n";
}
catch(IOException $ioe) {
    echo "IO exception : " . $ioe->getErrorMessage() . "\n";
}
catch(ParseException $pe) {
    echo "Parser exception : " . $pe->getErrorMessage() . "\n";
}
catch(Exception $e) {
    echo "Exception : " . $e->getMessage() . "\n";
}

?>
Copiedfrom __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:
    CLIENTID = "1000.xxxxxxx"
    CLIENTSECRET = "xxxxxxx"
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx"

    ORGID = "55522777"
    WORKSPACEID = "35130000001055707"

class Sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def automl_analysis_prediction(self, ac):
        analysis_id = "466206000000073001"
        model_id = "466206000000073003"

        features = {
            "Sales": 1000,
            "Region": "East",
            "Product Category": "Stationery"
        }

        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)

        prediction_result = workspace.automl_analysis_prediction(
            analysis_id,
            model_id,
            features
        )

        print("Prediction Result:")
        print(prediction_result)

try:
    obj = Sample()
    obj.automl_analysis_prediction(obj.ac)

except Exception as e:
    print(str(e))
Copiedvar analyticsClient = require('./AnalyticsClient');

var clientId = '';
var clientSecret = '';
var refreshToken = '';
var orgId = '';
var workspaceId = '';

var analysisId = "466206000000073001";
var modelId = "466206000000073003";

var features = {
    "Sales": 1000,
    "Region": "East",
    "Product Category": "Stationery"
};

var ac = new analyticsClient(clientId, clientSecret, refreshToken);

var workspace = ac.getWorkspaceInstance(orgId, workspaceId);

workspace.automlAnalysisPrediction(analysisId, modelId, features)
.then((response) => {
    console.log("Prediction Result:");
    console.log(response);
})
.catch((error) => {
    console.log('errorCode : ' + error.errorCode);
    console.log('errorMessage : ' + error.errorMessage);
});
Copiedrequire 'zoho_analytics_client'

class Config
  CLIENT_ID     = "1000.xxxxxxx"
  CLIENT_SECRET = "xxxxxxx"
  REFRESH_TOKEN = "1000.xxxxxxx.xxxxxxx"

  ORG_ID        = "55522777"
  WORKSPACE_ID  = "35130000001055707"
end

class Sample
  def initialize
    @ac = AnalyticsClient.new
           .with_data_center("US")
           .with_oauth({
             "clientId"     => Config::CLIENT_ID,
             "clientSecret" => Config::CLIENT_SECRET,
             "refreshToken" => Config::REFRESH_TOKEN
           })
           #.with_token_store_path("/home/admin/analytics_ruby_sdk/tokens") # Optional – specify a directory path to securely store the encrypted access token
           .build
  end

  def automl_analysis_prediction
    analysis_id = "466206000000073001"
    model_id    = "466206000000073003"

    features = {
      "Sales"            => 1000,
      "Region"           => "East",
      "Product Category" => "Stationery"
    }

    workspace = @ac.get_workspace_instance(Config::ORG_ID, Config::WORKSPACE_ID)

    prediction_result = workspace.automl_analysis_prediction(
      analysis_id,
      model_id,
      features
    )

    puts "Prediction Result:"
    puts prediction_result
  end
end

begin
  obj = Sample.new
  obj.automl_analysis_prediction
rescue ServerError => e
  puts "Server Error: #{e.response_content}"
rescue StandardError => e
  puts e.message
  puts e.backtrace.join("\n")
end

Download SDKs:  C# | GO | JAVA | PHP | PYTHON | NodeJS | Ruby

Sample value for CONFIG parameter:

Copied{
  "features": {
    "Sales": "1000",
    "Region": "East",
    "Product Category": "Stationery"
  }
}

Sample Response:

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "AutoML what if analysis",
    "data": {
        "predictions": "Fruits and Vegetables",
        "targetColumn": "Product"
    }
}