Zoho Analytics - Python Documentation

rename(self, view_name, config=`{}`)

source code

Rename a specified view in the workspace.

Parameters:

view_name (string) - New name of the view.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

delete(self, config=`{}`)

source code

Delete a specified view in the workspace.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

save_as(self, new_view_name, config=`{}`)

source code

Copy a specified view within the workspace.

Parameters:

new_view_name (string) - The name of the new view.
config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Created view id.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

copy_formulas(self, formula_names, dest_workspace_id, config=`{}`, dest_org_id=None)

source code

Copy the specified formulas from one table to another within the workspace or across workspaces.

Parameters:

formula_names (list) - The name of the formula columns to be copied.
dest_workspace_id (string) - The ID of the destination workspace.
dest_org_id (string) - Id of the organization where the destination workspace is present. Can be None.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

add_favorite(self)

source code

Adds a specified view as favorite.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

remove_favorite(self)

source code

Remove a specified view from favorite.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

create_similar_views(self, ref_view_id, folder_id, config=`{}`)

source code

Create reports for the specified table based on the reference table.

Parameters:

ref_view_id (string) - The ID of the reference view.
folder_id (string) - The folder id where the views to be saved.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

auto_analyse(self, config=`{}`)

source code

Auto generate reports for the specified table.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_my_permissions(self)

source code

Returns permissions for the specified view.

Returns: dictionary

Permission details.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_view_url(self, config=`{}`)

source code

Returns the URL to access the specified view.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

View URL.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_embed_url(self, config=`{}`)

source code

Returns embed URL to access the specified view.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Embed URL.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_private_url(self, config=`{}`)

source code

Returns private URL to access the specified view.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Private URL.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

create_private_url(self, config=`{}`)

source code

Create a private URL for the specified view.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Private URL.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

remove_private_access(self)

source code

Remove private link access for the specified view.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

make_view_public(self, config=`{}`)

source code

Make the specified view publically accessible.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Public URL.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

remove_public_access(self)

source code

Remove public access for the specified view.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_publish_configurations(self)

source code

Returns publish configurations for the specified view.

Returns: dictionary

Publish details.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

update_publish_configurations(self, config=`{}`)

source code

Update publish configurations for the specified view.

Parameters:

config (dictionary) - Contains the control parameters.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

add_column(self, column_name, data_type, config=`{}`)

source code

Add a column in the specified table.

Parameters:

column_name (string) - The name of the column.
data_type (string) - The data-type of the column.
config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Created column id.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

hide_columns(self, column_ids)

source code

Hide the specified columns in the table.

Parameters:

column_ids (list) - Ids of the columns to be hidden.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

show_columns(self, column_ids)

source code

Show the specified hidden columns in the table.

Parameters:

column_ids (list) - Ids of the columns to be shown.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

add_row(self, column_values, config=`{}`)

source code

Add a single row in the specified table.

Parameters:

column_values (dictionary) - Contains the values for the row. The column names are the key.
config (dictionary) - Contains any additional control parameters. Can be None.

Returns: dictionary

Column Names and Added Row Values.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

update_row(self, column_values, criteria, config=`{}`)

source code

Update rows in the specified table.

Parameters:

column_values (dictionary) - Contains the values for the row. The column names are the key.
criteria (string) - The criteria to be applied for updating data. Only rows matching the criteria will be updated. Should be null for update all rows.
config (dictionary) - Contains any additional control parameters. Can be None.

Returns: dictionary

Updated Columns List and Updated Rows Count.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

delete_row(self, criteria, config=`{}`)

source code

Delete rows in the specified table.

Parameters:

criteria (string) - The criteria to be applied for deleting data. Only rows matching the criteria will be deleted. Should be null for delete all rows.
config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Deleted rows details.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

rename_column(self, column_id, column_name, config=`{}`)

source code

Rename a specified column in the table.

Parameters:

column_id (string) - Id of the column.
column_name (string) - New name for the column.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

delete_column(self, column_id, config=`{}`)

source code

Delete a specified column in the table.

Parameters:

column_id (string) - Id of the column.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

add_lookup(self, column_id, ref_view_id, ref_column_id, config=`{}`)

source code

Add a lookup in the specified child table.

Parameters:

column_id (string) - Id of the column.
ref_view_id (string) - The id of the table contains the parent column.
ref_column_id (string) - The id of the parent column.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

remove_lookup(self, column_id, config=`{}`)

source code

Remove the lookup for the specified column in the table.

Parameters:

column_id (string) - Id of the column.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

auto_analyse_column(self, column_id, config=`{}`)

source code

Auto generate reports for the specified column.

Parameters:

column_id (string) - Id of the column.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

refetch_data(self, config=`{}`)

source code

Sync data from available datasource for the specified view.

Parameters:

config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_last_import_details(self)

source code

Returns last import details of the specified view.

Returns: dictionary

Last import details.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_formula_columns(self)

source code

Returns list of all formula columns for the specified table.

Returns: list

Formula column list.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

add_formula_column(self, formula_name, expression, config=`{}`)

source code

Add a formula column in the specified table.

Parameters:

formula_name (string) - Name of the formula column to be created.
expression (string) - Formula expression.
config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Created formula id.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

edit_formula_column(self, formula_id, expression, config=`{}`)

source code

Edit the specified formula column.

Parameters:

formula_id (string) - Id of the formula column to be updated.
expression (string) - Formula expression.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

delete_formula_column(self, formula_id, config=`{}`)

source code

Delete the specified formula column.

Parameters:

formula_id (string) - Id of the formula column to be deleted.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_aggregate_formulas(self)

source code

Returns list of all aggregate formulas for the specified table.

Returns: list

Aggregate Formula list.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

add_aggregate_formula(self, formula_name, expression, config=`{}`)

source code

Add an aggregate formula in the specified table.

Parameters:

formula_name (string) - Name of the aggregate formula to be created.
expression (string) - Formula expression.
config (dictionary) - Contains any additional control parameters. Can be None.

Returns: string

Created formula id.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

edit_aggregate_formula(self, formula_id, expression, config=`{}`)

source code

Edit the specified aggregate formula.

Parameters:

formula_id (string) - Id of the aggregate formula to be updated.
expression (string) - Formula expression.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

delete_aggregate_formula(self, formula_id, config=`{}`)

source code

Delete the specified aggregate formula.

Parameters:

formula_id (string) - Id of the aggregate formula to be deleted.
config (dictionary) - Contains any additional control parameters. Can be None.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_view_dependents(self)

source code

Returns list of dependents views for the specified view.

Returns: list

Dependent view list.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

get_column_dependents(self, column_id)

source code

Returns list of dependents views and formulas for the specified column.

Returns: dictionary

Dependent details.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

update_shared_details(self, config=`{}`)

source code

Update shared details of the specified view.

Parameters:

config (dictionary) - Contains the control parameters.

Raises:

ServerError - If the server has received the request but did not process the request due to some error.
ParseError - If the server has responded but client was not able to parse the response.

Class ViewAPI

rename(self, view_name, config={})

delete(self, config={})

save_as(self, new_view_name, config={})

copy_formulas(self, formula_names, dest_workspace_id, config={}, dest_org_id=None)

add_favorite(self)

remove_favorite(self)

create_similar_views(self, ref_view_id, folder_id, config={})

auto_analyse(self, config={})

get_my_permissions(self)

get_view_url(self, config={})

get_embed_url(self, config={})

get_private_url(self, config={})

create_private_url(self, config={})

remove_private_access(self)

make_view_public(self, config={})

remove_public_access(self)

get_publish_configurations(self)

update_publish_configurations(self, config={})

add_column(self, column_name, data_type, config={})

hide_columns(self, column_ids)

show_columns(self, column_ids)

add_row(self, column_values, config={})

update_row(self, column_values, criteria, config={})

delete_row(self, criteria, config={})

rename_column(self, column_id, column_name, config={})

delete_column(self, column_id, config={})

add_lookup(self, column_id, ref_view_id, ref_column_id, config={})

remove_lookup(self, column_id, config={})

auto_analyse_column(self, column_id, config={})

refetch_data(self, config={})

get_last_import_details(self)

get_formula_columns(self)

add_formula_column(self, formula_name, expression, config={})

edit_formula_column(self, formula_id, expression, config={})

delete_formula_column(self, formula_id, config={})

get_aggregate_formulas(self)

add_aggregate_formula(self, formula_name, expression, config={})

edit_aggregate_formula(self, formula_id, expression, config={})

delete_aggregate_formula(self, formula_id, config={})

get_view_dependents(self)

get_column_dependents(self, column_id)

update_shared_details(self, config={})

rename(self, view_name, config=`{}`)

delete(self, config=`{}`)

save_as(self, new_view_name, config=`{}`)

copy_formulas(self, formula_names, dest_workspace_id, config=`{}`, dest_org_id=None)

create_similar_views(self, ref_view_id, folder_id, config=`{}`)

auto_analyse(self, config=`{}`)

get_view_url(self, config=`{}`)

get_embed_url(self, config=`{}`)

get_private_url(self, config=`{}`)

create_private_url(self, config=`{}`)

make_view_public(self, config=`{}`)

update_publish_configurations(self, config=`{}`)

add_column(self, column_name, data_type, config=`{}`)

add_row(self, column_values, config=`{}`)

update_row(self, column_values, criteria, config=`{}`)

delete_row(self, criteria, config=`{}`)

rename_column(self, column_id, column_name, config=`{}`)

delete_column(self, column_id, config=`{}`)

add_lookup(self, column_id, ref_view_id, ref_column_id, config=`{}`)

remove_lookup(self, column_id, config=`{}`)

auto_analyse_column(self, column_id, config=`{}`)

refetch_data(self, config=`{}`)

add_formula_column(self, formula_name, expression, config=`{}`)

edit_formula_column(self, formula_id, expression, config=`{}`)

delete_formula_column(self, formula_id, config=`{}`)

add_aggregate_formula(self, formula_name, expression, config=`{}`)

edit_aggregate_formula(self, formula_id, expression, config=`{}`)

delete_aggregate_formula(self, formula_id, config=`{}`)

update_shared_details(self, config=`{}`)