ViewAPI

org       = ac.get_org_instance(ORG_ID)
workspace = ac.get_workspace_instance(ORG_ID, WORKSPACE_ID)
view      = ac.get_view_instance(ORG_ID, WORKSPACE_ID, VIEW_ID)
bulk      = ac.get_bulk_instance(ORG_ID, WORKSPACE_ID)

ViewAPI exposes 51 methods. Method names are snake_case and identifiers are string.

Methods#

add_aggregate_formula, add_column, add_favorite, add_formula_column, add_lookup, add_row, add_tags_to_view, auto_analyse, auto_analyse_column, copy_formulas, create_alert, create_private_url, create_similar_views, delete, delete_aggregate_formula, delete_column, delete_formula_column, delete_row, edit_aggregate_formula, edit_formula_column, get_aggregate_formulas, get_alerts_in_view, get_column_dependents, get_embed_url, get_formula_columns, get_last_import_details, get_my_permissions, get_private_url, get_publish_configurations, get_table_metadata, get_view_dependents, get_view_metadata_for_alert, get_view_tags, get_view_url, hide_columns, make_view_public, refetch_data, remove_favorite, remove_lookup, remove_private_access, remove_public_access, remove_tags_from_view, rename, rename_column, reorder_columns, save_as, show_columns, sort_data_by_columns, update_publish_configurations, update_row, update_shared_details

add_aggregate_formula#

add_aggregate_formula(formula_name, expression, config = {})

Adds an aggregate formula to the table.

Returns (String) — Formula ID.

add_column#

add_column(column_name, data_type, config = {})

Add a column to the view.

Returns (Integer) — Integer

add_favorite#

add_favorite()

Adds a specified view as favorite.

add_formula_column#

add_formula_column(formula_name, expression, config = {})

Adds a formula column to the table.

Returns (String) — Formula ID.

add_lookup#

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

Adds a lookup in the specified child table.

add_row#

add_row(column_values, config = {})

Adds a single row in the specified table.

Returns (Hash) — Response containing column names and added row values.

add_tags_to_view#

add_tags_to_view(tag_ids, config = {})

Adds multiple tags to the specified view.

auto_analyse#

auto_analyse(config = {})

Auto generate reports.

auto_analyse_column#

auto_analyse_column(column_id, config = {})

Auto generates reports for the specified column.

copy_formulas#

copy_formulas(formula_names, dest_workspace_id, config = {}, dest_org_id = nil)

Copy formulas to another workspace or view.

create_alert#

create_alert(alert_name, schedule_details, rules, config = {})

Create a data alert for the specified view.

Returns (String) — Created data alert id

create_private_url#

create_private_url(config = {})

Create private URL for the view.

Returns (String) — String

create_similar_views#

create_similar_views(ref_view_id, folder_id, config = {})

Create similar reports based on a reference view.

delete#

delete(config = {})

Delete a specified view in the workspace.

delete_aggregate_formula#

delete_aggregate_formula(formula_id, config = {})

Deletes an aggregate formula.

delete_column#

delete_column(column_id, config = {})

Deletes a specified column in the table.

delete_formula_column#

delete_formula_column(formula_id, config = {})

Deletes a formula column.

delete_row#

delete_row(criteria, config = {})

Deletes rows in the specified table.

Returns (String) — Deleted row details.

edit_aggregate_formula#

edit_aggregate_formula(formula_id, expression, config = {})

Edits an aggregate formula.

edit_formula_column#

edit_formula_column(formula_id, expression, config = {})

Edits a formula column.

get_aggregate_formulas#

get_aggregate_formulas()

Returns list of all aggregate formulas for the table.

Returns (Array) — Aggregate formulas.

get_alerts_in_view#

get_alerts_in_view()

Returns list of data alerts configured for the specified view.

Returns (Array) — Data alerts list

get_column_dependents#

get_column_dependents(column_id)

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

Returns (Hash) — Dependent details

get_embed_url#

get_embed_url(config = {})

Get embed URL of the view.

Returns (String) — String

get_formula_columns#

get_formula_columns()

Returns list of all formula columns for the table.

Returns (Array) — Formula columns.

get_last_import_details#

get_last_import_details()

Returns last import details of the view.

Returns (Hash) — Last import details.

get_my_permissions#

get_my_permissions()

Get user permissions for the view.

Returns (Hash) — Hash

get_private_url#

get_private_url(config = {})

Get private URL of the view.

Returns (String) — String

get_publish_configurations#

get_publish_configurations()

Get publish configurations of the view.

Returns (Hash) — Hash

get_table_metadata#

get_table_metadata()

Returns metadata details like columns present for the specified table.

Returns (Hash) — Table metadata details

get_view_dependents#

get_view_dependents()

Returns the dependent views of this view.

Returns (Array) — List of dependent views.

get_view_metadata_for_alert#

get_view_metadata_for_alert()

Returns the view metadata that can be used while configuring a data alert for the specified view.

Returns (Hash) — View metadata for data alert configuration

get_view_tags#

get_view_tags()

Returns the list of tags associated with the specified view.

Returns (Array) — Tags list

get_view_url#

get_view_url(config = {})

Get the URL to access the view.

Returns (String) — String

hide_columns#

hide_columns(column_ids)

Hide columns in the view.

make_view_public#

make_view_public(config = {})

Make the view publicly accessible.

Returns (String) — String

refetch_data#

refetch_data(config = {})

Syncs data from the available data source for the view.

remove_favorite#

remove_favorite()

Removes a specified view from favorites.

remove_lookup#

remove_lookup(column_id, config = {})

Removes the lookup for the specified column in the table.

remove_private_access#

remove_private_access()

Remove private access for the view.

remove_public_access#

remove_public_access()

Remove public access for the view.

remove_tags_from_view#

remove_tags_from_view(tag_ids = nil, dissociate_all = false, config = {})

Removes multiple tags from the specified view.

rename#

rename(view_name, config = {})

Rename a specified view in the workspace.

rename_column#

rename_column(column_id, column_name, config = {})

Renames a specified column in the table.

reorder_columns#

reorder_columns(column_ids, config = {})

Updates the column order of the current table.

save_as#

save_as(new_view_name, config = {})

Copy a specified view within the workspace.

Returns (Integer) — Created view ID

show_columns#

show_columns(column_ids)

Show hidden columns in the view.

sort_data_by_columns#

sort_data_by_columns(columns = nil, sort_order = nil, reset_sort = false, config = {})

Sorts the data in the current table based on the specified columns.

update_publish_configurations#

update_publish_configurations(config = {})

Update publish configurations of the view.

update_row#

update_row(column_values, criteria, config = {})

Updates rows in the specified table.

Returns (Hash) — Updated columns list and row count.

update_shared_details#

update_shared_details(config = {})

Updates the shared details of the specified view.

Related#

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