- Introduction
- API Specification
- Prerequisites
- Authentication
- Data APIs
- Bulk APIs
- Modeling APIs
- Create Workspace
- Copy Workspace
- Rename Workspace
- Delete Workspace
- Create Table
- Create Query Table
- Edit Query Table
- Create Report
- Update Report
- Save As View
- Move Views To Folder
- Rename View
- Delete View
- Restore Trash Views
- Delete Trash Views
- Create Folder
- Rename Folder
- Make Default Folder
- Change Folder Hierarchy
- Change Folder Position
- Delete Folder
- Add Column
- Rename Column
- Delete Column
- Add Lookup
- Remove Lookup
- Hide Columns
- Show Columns
- Copy Views
- Copy Formulas
- Create Similar Views
- Auto Analyse View
- Auto Analyse Column
- Get Variables
- Get Variable Details
- Create Variable
- Update Variable
- Delete Variable
- Add Formula Column
- Edit Formula Column
- Delete Formula Column
- Add Aggregate Formula
- Edit Aggregate Formula
- Delete Aggregate Formula
- Create Email Schedule
- Update Email Schedule
- Trigger Email Schedule
- Change Email Schedule Status
- Delete Email Schedule
- Error codes
- Metadata APIs
- Get Organizations
- Get All Workspaces
- Get Owned Workspaces
- Get Shared Workspaces
- Get Views
- Get Folders
- Get Recent Views
- Get Trash Views
- Get Dashboards
- Get Owned Dashboards
- Get Shared Dashboards
- Get Workspace Secretkey
- Get Workspace Details
- Get View Details
- Get View Dependents
- Get Column Dependents
- Add Favorite Workspace
- Remove Favorite Workspace
- Add Default Workspace
- Remove Default Workspace
- Add Favorite View
- Remove Favorite View
- Export AS Template
- Get Formula Column List
- Get Aggregate Formula List
- Get Aggregate Formula In Workspace
- Get Aggregate Formula Dependents
- Get Aggregate Formula Value
- Get Meta Details
- Get Email Schedule
- Get Datasources
- Sync Data
- Refetch Data
- Get Last Import Details
- Update Datasource Connection
- Enable Domain Workspace
- Disable Domain Workspace
- Error codes
- Sharing and Collaboration APIs
- Get Org Admins
- Get Workspace Admins
- Add Workspace Admins
- Remove Workspace Admins
- Get Workspace Shared Details
- Share Views
- Remove Share
- Get My Permissions
- Get Shared Details For Views
- Update Shared Details For View
- Get Groups
- Get Group Details
- Create Group
- Rename Group
- Add Group Members
- Remove Group Members
- Delete Group
- Error codes
- Embed APIs
- User Management APIs
- Single Sign On Integration
- Common error codes in API
- Zoho Analytics MCP Server
- JS API
- SDKs
- Zoho Analytics CloudSQL
- Rest API Collections
- API Usage Limits & Pricing
Get Import Job Details
Using Get Import Job Details API, you can check the status of the specified import job periodically. Upon job completion the system notifies the user in the callback URL (if provided).
REQUEST URI
https://<ZohoAnalytics_Server_URI>/restapi/v2/bulk/workspaces/<workspace-id>/importjobs/<job-id>
Getoauthscope: ZohoAnalytics.data.create
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/bulk/workspaces/<workspace-id>/importjobs/<job-id>
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'
Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;
using System.Text.Json;
namespace ZohoAnalyticsTest
{
class Program
{
long orgId = 55522777;
long workspaceId = 35130000001055707;
public void GetImportJobDetails(IAnalyticsClient ac)
{
long jobId = 1767024000009297003;
IBulkAPI data = ac.GetBulkInstance(orgId, workspaceId);
JsonElement jobInfo = data.GetImportJobDetails(jobId);
Console.WriteLine(jobInfo);
}
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.GetImportJobDetails(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 GetImportJobDetails(ac ZAnalytics.Client) {
jobid := "35130000001345001"
bulk := ZAnalytics.GetBulkInstance(&ac, orgId, workspaceId)
result, err := bulk.GetImportJobDetails(jobid)
if(err != nil){
fmt.Println(err.ErrorMessage)
}else{
fmt.Println(result)
}
}
func main() {
ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
GetImportJobDetails(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.getImportJobDetails(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 getImportJobDetails(AnalyticsClient ac) throws Exception {
long jobId = 35130000001343088l;
BulkAPI data = ac.getBulkInstance(orgId, workspaceId);
JSONObject jobInfo = data.getImportJobDetails(jobId);
System.out.println(jobInfo);
}
}
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 getImportJobDetails() {
$job_id = "35130000001342088";
$bulk = $this->ac->getBulkInstance($this->org_id, $this->workspace_id);
$response = $bulk->getImportJobDetails($job_id);
print_r($response);
}
}
$test_obj = new Test();
try {
$test_obj->getImportJobDetails();
}
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->getErrorMessage() . "\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 get_import_job_details(self, ac):
job_id = "35130000001336083"
bulk = ac.get_bulk_instance(Config.ORGID, Config.WORKSPACEID)
result = bulk.get_import_job_details(job_id)
print(result)
try:
obj = sample()
obj.get_import_job_details(obj.ac);
except Exception as e:
print(str(e))
Copiedvar analyticsClient = require('./AnalyticsClient');
var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var ac = new analyticsClient(clientId, clientSecret, refreshtoken);
var jobId = '';
var bulk = ac.getBulkInstance(orgId, workspaceId);
bulk.getImportJobDetails(jobId).then((response) => {
console.log(response);
}).catch((error) => {
console.log('errorCode : '+error.errorCode);
console.log('errorMessage : '+error.errorMessage);
});
CopiedorgId = "55522777";
workspaceId = "35130000001055707";
jobId = "5888000000222090";
headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);
response = invokeurl
[
url :"https://analyticsapi.zoho.com/restapi/v2/bulk/workspaces/" + workspaceId + "/importjobs/" + jobId
type :GET
headers:headersMap
connection:"analytics_oauth_connection"
];
info response;
Show full
Show less
Download client libraries: C# | GO | JAVA | PHP | PYTHON | NodeJS
Sample Response:
CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
"status": "success",
"summary": "Fetch import job info",
"data": {
"jobId": "1767024000003153087",
"jobCode": "1004",
"jobStatus": "JOB COMPLETED",
"jobInfo": {
"viewId": "1767024000003154002",
"importSummary": {
"importType": "APPEND",
"totalColumnCount": 7,
"selectedColumnCount": 7,
"totalRowCount": 755,
"successRowCount": 755,
"warnings": 0,
"importOperation": "created"
},
"columnDetails": {
"Date": "Date",
"Region": "Plain Text",
"Product Category": "Plain Text",
"Product": "Plain Text",
"Customer Name": "Plain Text",
"Sales": "Currency",
"Cost": "Currency"
},
"importErrors": ""
},
"expiryTime": "1623764592309"
}
}
Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.