Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Analytics Embed APIs API

Embed APIs let you dynamically integrate Zoho Analytics reports and dashboards into your websites and applications.

Zoho Analytics Embed APIs API is one of 11 APIs that Zoho Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Embed APIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 15 operations across 8 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://analyticsapi.zoho.com.

15 operations 8 paths 18 schemas 3 DELETE7 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://analyticsapi.zoho.com/restapi/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Analytics Embed APIs API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (iam-oauth2-schema) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

Paths & Operations 15

Across 8 paths, the API surfaces 15 operations — 3 DELETE, 7 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Embed APIs 15

Embed APIs let you dynamically integrate Zoho Analytics reports and dashboards into your websites and applications.

GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish
Get View URL
getViewUrl 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/embed
Get Embed URL
getEmbedUrl 3 params → 200default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/privatelink
Get Private URL
getPrivateUrl 3 params → 200default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/privatelink
Create Private URL
createPrivateUrl 3 params body → 200default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/privatelink
Remove Private Access
removePrivateAccess 3 params → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/public
Make Views Public
makeViewsPublic 3 params body → 200default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/public
Remove Public Permission
removePublicPermission 3 params → 204default
GET
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/config
Get Publish Configurations
getPublishConfigurations 3 params → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/publish/config
Update Publish Configurations
updatePublishConfigurations 3 params body → 204default
GET
/restapi/v2/workspaces/{workspace-id}/slides
Get Slideshows
getSlideshows 2 params → 200default
POST
/restapi/v2/workspaces/{workspace-id}/slides
Create Slideshow
createSlideshow 1 param body → 200default
GET
/restapi/v2/workspaces/{workspace-id}/slides/{slide-id}
Get Slideshow Details
getSlideshowDetails 3 params → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/slides/{slide-id}
Update Slideshow
updateSlideshow 2 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/slides/{slide-id}
Delete Slideshow
deleteSlideshow 2 params → 204default
GET
/restapi/v2/workspaces/{workspace-id}/slides/{slide-id}/publish
Get Slideshow URL
getSlideshowUrl 4 params → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are GetEmbedUrlConfig (13 properties), UpdatePublishConfigurationsConfig (13 properties), CreatePrivateUrlConfig (10 properties), GetViewUrlConfig (8 properties). Each schema is shown below with its type and property counts.

CreatePrivateUrlResponse
object
3 properties
GetPrivateUrlConfig
object
1 property
GetEmbedUrlResponse
object
3 properties
GetViewUrlResponse
object
3 properties
GetViewUrlConfig
object
8 properties
CreateSlideshowResponse
object
3 properties
GetSlideshowUrlResponse
object
3 properties
GetSlideshowDetailsResponse
object
3 properties
MakeViewsPublicConfig
object
6 properties
GetPrivateUrlResponse
object
3 properties
MakeViewsPublicResponse
object
3 properties
UpdatePublishConfigurationsConfig
object
13 properties
GetEmbedUrlConfig
object
13 properties
GetSlideshowsResponse
object
3 properties
UpdateSlideshowConfig
object
4 properties
CreatePrivateUrlConfig
object
10 properties
CreateSlideshowConfig
object
3 properties 2 required
GetPublishConfigurationsResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-analytics-embed-apis-api-openapi.yml Raw ↑

Other APIs Zoho Analytics publishes across the network.

Zoho Analytics Bulk Export - Asynchronous API
Zoho Analytics Bulk Export - Synchronous API
Zoho Analytics Bulk Import - Asynchronous API
Zoho Analytics Bulk Import - Batch API
Zoho Analytics Bulk Import - Synchronous API
Zoho Analytics Data APIs API
Zoho Analytics Metadata APIs API
Zoho Analytics Modeling APIs API
Zoho Analytics Sharing & Collaboration APIs API
Zoho Analytics User Management APIs API