Reference
AnalyticsClient
The entry point. 9 methods.
<?php
require 'AnalyticsClient.php';
$client_id = "1000.xxxxxxx";
$client_secret = "xxxxxxx";
$refresh_token = "1000.xxxxxxx.xxxxxxx";
$ac = new AnalyticsClient($client_id, $client_secret, $refresh_token);AnalyticsClient exposes 9 methods. Method names are camelCase and identifiers are string.
Methods#
getBulkInstance, getConnectionTimeout, getOrgInstance, getReadTimeout, getViewInstance, getWorkspaceInstance, setConnectionTimeout, setProxy, setReadTimeout
getBulkInstance#
getBulkInstance($org_id, $workspace_id)Returns a new BulkAPI instance.
| Parameter | Type | Description |
|---|---|---|
org_id | string | The ID of the organization. |
workspace_id | string | The ID of the workspace. |
Returns — instance.
getConnectionTimeout#
getConnectionTimeout()Returns the timeout until a connection is established.A value of zero means the timeout is not used.
Returns — Connection timeout limit.
getOrgInstance#
getOrgInstance($org_id)Returns a new OrgAPI instance.
| Parameter | Type | Description |
|---|---|---|
org_id | string | The ID of the organization. |
Returns — instance.
getReadTimeout#
getReadTimeout()Returns the timeout until waiting to read data. A value of zero means the timeout is not used. The default value is 15000.
Returns — Read timeout limit.
getViewInstance#
getViewInstance($org_id, $workspace_id, $view_id)Returns a new ViewAPI instance.
| Parameter | Type | Description |
|---|---|---|
org_id | string | The ID of the organization. |
workspace_id | string | The ID of the workspace. |
view_id | string | The ID of the view. |
Returns — instance.
getWorkspaceInstance#
getWorkspaceInstance($org_id, $workspace_id)Returns a new WorkspaceAPI instance.
| Parameter | Type | Description |
|---|---|---|
org_id | string | The ID of the organization. |
workspace_id | string | The ID of the workspace. |
Returns — instance.
setConnectionTimeout#
setConnectionTimeout($time_limit)Sets the timeout until a connection is established. A value of zero means the timeout is not used. The default value is 15000.
| Parameter | Type | Description |
|---|---|---|
time_limit | int | An integer value. |
setProxy#
setProxy($proxy_host, $proxy_port, $proxy_type, $proxy_user_name, $proxy_password)Used to specify the proxy server details.
| Parameter | Type | Description |
|---|---|---|
proxy_host | string | The hostname/ip address of the proxy-server. |
proxy_port | int | The proxy server port. |
proxy_type | string | Can be any one ( HTTP , HTTPS , BOTH ).Specify "BOTH" if same configuration can be used for both HTTP and HTTPS. |
proxy_user_name | string | The user name for proxy-server authentication. |
proxy_password | string | The password for proxy-server authentication. |
setReadTimeout#
setReadTimeout($time_limit)Sets the timeout until waiting to read data. A value of zero means the timeout is not used. The default value is 15000.
| Parameter | Type | Description |
|---|---|---|
time_limit | int | An integer value. |