{ "opencollection": "1.0.0", "info": { "name": "Helpcenter Embed APIs API", "version": "1.0.0" }, "items": [ { "info": { "name": "Embed APIs", "type": "folder" }, "items": [ { "info": { "name": "Get View URL", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." }, { "name": "CONFIG", "value": "", "type": "query" } ] }, "docs": "Returns the URL to access the specified view." }, { "info": { "name": "Get Embed URL", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/embed", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." }, { "name": "CONFIG", "value": "", "type": "query" } ] }, "docs": "Returns embed URL to access the specified view." }, { "info": { "name": "Get Private URL", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/privatelink", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "view-id", "value": "", "type": "path", "description": "ID of the view." }, { "name": "CONFIG", "value": "", "type": "query" } ] }, "docs": "Returns private URL to access the specified view." }, { "info": { "name": "Create Private URL", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/privatelink", "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." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Create a private URL for the specified view." }, { "info": { "name": "Remove Private Access", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/privatelink", "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 private link access for the specified view." }, { "info": { "name": "Make Views Public", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/public", "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." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Make the specified view publicly accessible." }, { "info": { "name": "Remove Public Permission", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/public", "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 Public Permission" }, { "info": { "name": "Get Publish Configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/config", "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 Publish Configurations" }, { "info": { "name": "Update Publish Configurations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/views/:view-id/publish/config", "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." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Update Publish Configurations" }, { "info": { "name": "Get Slideshows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/slides", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ] }, "docs": "Get Slideshows" }, { "info": { "name": "Create Slideshow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/slides", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Create a slideshow in the specified workspace." }, { "info": { "name": "Get Slideshow Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/slides/:slide-id", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "slide-id", "value": "", "type": "path", "description": "ID of the slide." } ] }, "docs": "Get Slideshow Details" }, { "info": { "name": "Update Slideshow", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/slides/:slide-id", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "slide-id", "value": "", "type": "path", "description": "ID of the slide." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "CONFIG", "value": "" } ] } }, "docs": "Update details of the specified slideshow." }, { "info": { "name": "Delete Slideshow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/slides/:slide-id", "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "slide-id", "value": "", "type": "path", "description": "ID of the slide." } ] }, "docs": "Delete a specified slideshow in the workspace." }, { "info": { "name": "Get Slideshow URL", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/restapi/v2/workspaces/:workspace-id/slides/:slide-id/publish", "headers": [ { "name": "ZANALYTICS-ORGID", "value": "" } ], "params": [ { "name": "workspace-id", "value": "", "type": "path", "description": "ID of the workspace." }, { "name": "slide-id", "value": "", "type": "path", "description": "ID of the slide." }, { "name": "CONFIG", "value": "", "type": "query", "description": "CONFIG JSON as stringified and URL-encoded" } ] }, "docs": "Get Slideshow URL" } ] } ], "bundled": true }