Class AnalyticsClient

AnalyticsClient provides the C# based language binding to the HTTPS based API of Zoho Analytics.

Inheritance

System.Object

AnalyticsClient

Implements

IAnalyticsClient

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ZohoAnalytics

Assembly: ZohoAnalytics.dll

Syntax

public class AnalyticsClient : IAnalyticsClient

Constructors

AnalyticsClient(String, String, String)

Creates a new AnalyticsClient instance.

Declaration

public AnalyticsClient(string clientId, string clientSecret, string refreshToken)

Parameters

Type	Name	Description
System.String	clientId	The client ID string that has been obtained during the client registration.
System.String	clientSecret	The client secret string that has been obtained during the client registration.
System.String	refreshToken	The refresh token string that has been obtained through accounts API.

Methods

GetBulkInstance(Int64, Int64)

Creates a new BulkAPI instance.

Declaration

public IBulkAPI GetBulkInstance(long orgId, long workspaceId)

Parameters

Type	Name	Description
System.Int64	orgId	The ID of the organization.
System.Int64	workspaceId	The ID of the workspace.

Returns

Type	Description
IBulkAPI	BulkAPI instance.

GetConnectionTimeout()

Returns the timeout until a connection is established.

Declaration

public int GetConnectionTimeout()

Returns

Type	Description
System.Int32	The timeout value.

GetDashboards()

Returns list of all accessible dashboards.

Declaration

public JsonElement GetDashboards()

Returns

Type	Description
System.Text.Json.JsonElement	All dashboards list.

GetOrgInstance(Int64)

Creates a new OrgAPI instance.

Declaration

public IOrgAPI GetOrgInstance(long orgId)

Parameters

Type	Name	Description
System.Int64	orgId	The ID of the organization.

Returns

Type	Description
IOrgAPI	OrgAPI instance.

GetOrgs()

Returns list of all accessible organizations.

Declaration

public JsonElement GetOrgs()

Returns

Type	Description
System.Text.Json.JsonElement	Organizations list.

GetOwnedDashboards()

Returns list of owned dashboards.

Declaration

public JsonElement GetOwnedDashboards()

Returns

Type	Description
System.Text.Json.JsonElement	Owned dashboards list.

GetOwnedWorkspaces()

Returns list of owned workspaces.

Declaration

public JsonElement GetOwnedWorkspaces()

Returns

Type	Description
System.Text.Json.JsonElement	Owned workspaces list.

GetReadTimeout()

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

Declaration

public int GetReadTimeout()

Returns

Type	Description
System.Int32	The timeout value.

GetRecentViews()

Returns list of recently accessed views.

Declaration

public JsonElement GetRecentViews()

Returns

Type	Description
System.Text.Json.JsonElement	Recent views list.

GetSharedDashboards()

Returns list of shared dashboards.

Declaration

public JsonElement GetSharedDashboards()

Returns

Type	Description
System.Text.Json.JsonElement	Shared dashboards list.

GetSharedWorkspaces()

Returns list of shared workspaces.

Declaration

public JsonElement GetSharedWorkspaces()

Returns

Type	Description
System.Text.Json.JsonElement	Shared workspaces list.

GetViewDetails(Int64, Dictionary<String, Object>)

Returns details of the specified view.

Declaration

public JsonElement GetViewDetails(long viewId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	viewId	Id of the view.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Text.Json.JsonElement	View details.

GetViewInstance(Int64, Int64, Int64)

Creates a new ViewAPI instance.

Declaration

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

Parameters

Type	Name	Description
System.Int64	orgId	The ID of the organization.
System.Int64	workspaceId	The ID of the workspace.
System.Int64	viewId	The ID of the view.

Returns

Type	Description
IViewAPI	ViewAPI instance.

GetWorkspaceDetails(Int64)

Returns details of the specified workspace.

Declaration

public JsonElement GetWorkspaceDetails(long workspaceId)

Parameters

Type	Name	Description
System.Int64	workspaceId	Id of the workspace.

Returns

Type	Description
System.Text.Json.JsonElement	Workspace details.

GetWorkspaceInstance(Int64, Int64)

Creates a new WorkspaceAPI instance.

Declaration

public IWorkspaceAPI GetWorkspaceInstance(long orgId, long workspaceId)

Parameters

Type	Name	Description
System.Int64	orgId	The ID of the organization.
System.Int64	workspaceId	The ID of the workspace.

Returns

Type	Description
IWorkspaceAPI	WorkspaceAPI instance.

GetWorkspaces()

Returns list of all accessible workspaces.

Declaration

public JsonElement GetWorkspaces()

Returns

Type	Description
System.Text.Json.JsonElement	All workspaces list.

SetAccountsServerURL(String)

Sets the accounts server URL.

Declaration

public void SetAccountsServerURL(string serverUrl)

Parameters

Type	Name	Description
System.String	serverUrl	ZohoAccounts server URL

SetAnalyticsServerURL(String)

Sets the analytics server URL.

Declaration

public void SetAnalyticsServerURL(string serverUrl)

Parameters

Type	Name	Description
System.String	serverUrl	ZohoAnalytics server URL

SetConnectionTimeout(Int32)

Sets the timeout until a connection is established.

Declaration

public void SetConnectionTimeout(int timeout)

Parameters

Type	Name	Description
System.Int32	timeout	The timeout value.

SetProxy(String, Int32, String, String)

To specify the proxy server details.

Declaration

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

Parameters

Type	Name	Description
System.String	proxyHost	The hostname/IP address of the proxy server.
System.Int32	proxyPort	The proxy server port.
System.String	proxyUsername	The user name for proxy-server authentication.
System.String	proxyPassword	The password for proxy server authentication.

SetReadTimeout(Int32)

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

Declaration

public void SetReadTimeout(int timeout)

Parameters

Type	Name	Description
System.Int32	timeout	The timeout value.

Implements

IAnalyticsClient