AnalyticsClient

using ZohoAnalytics;
using System.Collections.Generic;
using System.Text.Json;

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

IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

AnalyticsClient exposes 12 methods. Method names are PascalCase and identifiers are long.

Methods#

GetBulkInstance, GetConnectionTimeout, GetOrgInstance, GetReadTimeout, GetViewInstance, GetWorkspaceInstance, SetAccountsServerURL, SetAnalyticsServerURL, SetConnectionTimeout, SetDebugLogPath, SetProxy, SetReadTimeout

GetBulkInstance#

IBulkAPI GetBulkInstance(long orgId, long workspaceId)

Creates a new BulkAPI instance.

Returns (IBulkAPI) — BulkAPI instance.

GetConnectionTimeout#

int GetConnectionTimeout()

Returns the timeout until a connection is established.

Returns (int) — The timeout value.

GetOrgInstance#

IOrgAPI GetOrgInstance(long orgId)

Creates a new OrgAPI instance.

Returns (IOrgAPI) — OrgAPI instance.

GetReadTimeout#

int GetReadTimeout()

Returns the read timeout value which will wait for the packet to receive from the server end.

Returns (int) — The timeout value.

GetViewInstance#

IViewAPI GetViewInstance(long orgId, long workspaceId, long viewId)

Creates a new ViewAPI instance.

Returns (IViewAPI) — ViewAPI instance.

GetWorkspaceInstance#

IWorkspaceAPI GetWorkspaceInstance(long orgId, long workspaceId)

Creates a new WorkspaceAPI instance.

Returns (IWorkspaceAPI) — WorkspaceAPI instance.

SetAccountsServerURL#

void SetAccountsServerURL(string serverUrl)

Sets the accounts server URL.

SetAnalyticsServerURL#

void SetAnalyticsServerURL(string serverUrl)

Sets the analytics server URL.

SetConnectionTimeout#

void SetConnectionTimeout(int timeout)

Sets the timeout until a connection is established.

SetDebugLogPath#

void SetDebugLogPath(string logFilePath)

Sets the file path for the debug log. Call this before making any API calls.

SetProxy#

void SetProxy(string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)

To specify the proxy server details.

SetReadTimeout#

void SetReadTimeout(int timeout)

Sets the read timeout which will wait for data response from the server end.

Related#

• Errors — the failure envelope and codes worth branching on.
• Limits — throttles and quotas that apply to these calls.