{ "opencollection": "1.0.0", "info": { "name": "Helpcenter Metadata APIs API", "version": "1.0.0" }, "items": [ { "info": { "name": "Metadata APIs", "type": "folder" }, "items": [ { "info": { "name": "Get organizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/orgs" }, "docs": "Retrieve a list of organizations accessible by the authenticated user." }, { "info": { "name": "Get all workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ] }, "docs": "Retrieve a list of all workspaces accessible by the authenticated user." }, { "info": { "name": "Get owned workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/owned", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ] }, "docs": "Retrieve a list of workspaces owned by the authenticated user." }, { "info": { "name": "Get shared workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/shared", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ] }, "docs": "Retrieve a list of workspaces shared with the authenticated user." }, { "info": { "name": "Get Views", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Get Views" }, { "info": { "name": "Get Folders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/folders", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Get Folders" }, { "info": { "name": "Get Recent Views", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/recentviews" }, "docs": "Returns list of recently accessed views." }, { "info": { "name": "Get Trash Views", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/trash", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Returns list of all views available in trash for the specified workspace." }, { "info": { "name": "Get Dashboards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/dashboards" }, "docs": "Returns list of all accessible dashboards." }, { "info": { "name": "Get Owned Dashboards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/dashboards/owned" }, "docs": "Get Owned Dashboards" }, { "info": { "name": "Get Shared Dashboards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/dashboards/shared" }, "docs": "Get Shared Dashboards" }, { "info": { "name": "Get Workspace Secret Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/secretkey", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Get Workspace Secret Key" }, { "info": { "name": "Get Workspace Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Get Workspace Details" }, { "info": { "name": "Get View Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/views/:view-id", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." }, { "name": "CONFIG", "value": "", "type": "query", "description": "JSON object with keys like 'withInvolvedMetaInfo'. Needs to be stringified and URL-encoded." } ] }, "docs": "Get View Details" }, { "info": { "name": "Get QueryTable Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/querytables/:query-table-id", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "query-table-id", "value": "", "type": "path", "description": "ID of the query table." } ] }, "docs": "Returns details of the specified query table." }, { "info": { "name": "Get Table Metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/metadata", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Returns metadata details such as available columns and their attributes for the specified table." }, { "info": { "name": "Get View Dependents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/dependents", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Get View Dependents" }, { "info": { "name": "Get Column Dependents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/columns/:column-id/dependents", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." }, { "name": "column-id", "value": "", "type": "path", "description": "ID of the column." } ] }, "docs": "Get Column Dependents" }, { "info": { "name": "Add Favorite Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/favorite", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Add Favorite Workspace" }, { "info": { "name": "Remove Favorite Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/favorite", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Remove Favorite Workspace" }, { "info": { "name": "Add Default Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/default", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Add Default Workspace" }, { "info": { "name": "Remove Default Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/default", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Remove Default Workspace" }, { "info": { "name": "Add Favorite View", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/favorite", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Add Favorite View" }, { "info": { "name": "Remove Favorite View", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/favorite", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Remove Favorite View" }, { "info": { "name": "Export as Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/template/data", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "CONFIG", "value": "", "type": "query", "description": "Stringified and URL-encoded JSON object containing 'viewIds'." } ] }, "docs": "Export as Template" }, { "info": { "name": "Get Custom Formula List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/customformulas", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Returns list of all formula columns for the specified table." }, { "info": { "name": "Get Aggregate Formula List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/aggregateformulas", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Returns list of all aggregate formulas for the specified table." }, { "info": { "name": "Get Aggregate Formulas In Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/aggregateformulas", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Returns list of all aggregate formulas for the specified workspace." }, { "info": { "name": "Get Aggregate Formula Dependents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/aggregateformulas/:formula-id/dependents", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "formula-id", "value": "", "type": "path", "description": "The ID of the aggregate formula." } ] }, "docs": "Returns list of all dependent views and formulas for the specified aggregate formula." }, { "info": { "name": "Get Aggregate Formula Value", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/aggregateformulas/:formula-id/value", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "formula-id", "value": "", "type": "path", "description": "The ID of the aggregate formula." } ] }, "docs": "Returns the value of the aggregate formula." }, { "info": { "name": "Get Meta Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/metadetails", "params": [ { "name": "CONFIG", "value": "", "type": "query" } ] }, "docs": "Returns details of the specified workspace or view." }, { "info": { "name": "Get Email Schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/emailschedules", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Returns list of email schedules available in the specified workspace." }, { "info": { "name": "Get Datasources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/datasources", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Fetches datasources for the specified view." }, { "info": { "name": "Get Last Import Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/importdetails", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Returns details of the last data import for the specified view." }, { "info": { "name": "Sync Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/datasource/:datasource-id/sync", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Triggers a manual data sync for the specified view's datasource." }, { "info": { "name": "Refetch Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/sync", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." } ] }, "docs": "Refetches data from the source for the specified view." }, { "info": { "name": "Update Datasource Connection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/datasource/:datasource-id", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "datasource-id", "value": "", "type": "path", "description": "ID of the datasource." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Updates the datasource connection details for the specified view." }, { "info": { "name": "Enable Domain Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/wlaccess", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Enable workspace access for a specified white label domain." }, { "info": { "name": "Disable Domain Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/wlaccess", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Disable workspace access for the specified white label domain." }, { "info": { "name": "Get AutoML Analysis In Org", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/automl/analysis", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ] }, "docs": "Returns all AutoML analysis available in an organization." }, { "info": { "name": "Get AutoML Analysis In Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/automl/workspaces/:workspace-id/analysis", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Returns list of AutoML analysis for the specified workspace." }, { "info": { "name": "Get AutoML Analysis Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/automl/workspaces/:workspace-id/analysis/:analysis-id", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "analysis-id", "value": "", "type": "path", "description": "ID of the AutoML analysis." } ] }, "docs": "Retrieve detailed information for a specific AutoML analysis." }, { "info": { "name": "Get Deployments For A Model", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/automl/workspaces/:workspace-id/analysis/:analysis-id/models/:model-id/deployments", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "analysis-id", "value": "", "type": "path", "description": "ID of the AutoML analysis." }, { "name": "model-id", "value": "", "type": "path", "description": "ID of the AutoML analysis model." } ] }, "docs": "Returns deployment details available for an AutoML analysis model." } ] } ], "bundled": true }