Zoho Analytics Metadata API

Zoho Analytics is a self-service business intelligence and data analytics platform for creating reports and dashboards. The Metadata API exposes the organizational structure behind your analytics account — organizations, workspaces, views, dashboards, folders, and users — and lets you push rows into workspace tables. Nexla connects to the Zoho Analytics API v2 over REST to read this metadata and to write data into your workspaces.

Power end-to-end data operations for your Zoho Analytics Metadata API API with Nexla. Our bi-directional Zoho Analytics Metadata API connector is purpose-built for Zoho Analytics Metadata API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Zoho Analytics Metadata API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Zoho Analytics Metadata API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Zoho Analytics Metadata API credential, you need an OAuth 2.0 client registered with Zoho and the base URL for your Zoho Analytics data center. Zoho Analytics authenticates API requests using the OAuth 2.0 authorization-code flow, and Nexla completes this flow for you when you authorize the connection.

To obtain your credentials, follow these steps:

1. Sign in to the Zoho API Console with the Zoho account that has access to your Zoho Analytics organization.

2. Add a new client and choose the Server-based Applications client type (a web application that can complete the OAuth authorization-code flow).

3. Enter a name for the client, your application's homepage URL, and the authorized redirect URI. When authorizing through Nexla, use the redirect URI provided by the Nexla credential screen.

4. After the client is created, open the Client Secret tab to view your Client ID and Client Secret. Copy both values and store them securely.

5. Confirm the base URL that matches your Zoho data center. Zoho Analytics serves the API from a region-specific host — for example, https://analyticsapi.zoho.com/restapi/v2 for the US data center, with equivalent hosts under the .eu, .in, .com.au, and .jp domains for other regions. Use the base URL for the region where your Zoho account is hosted.

6. When you create the credential in Nexla, you will be redirected to Zoho to sign in and grant access. Approve the requested scopes so Nexla can read metadata and, if you plan to use the connector as a destination, write data into your workspaces.

The Client ID and Client Secret identify your application to Zoho during the token exchange. Access is granted against the workspaces and organizations available to the authorizing Zoho account, so make sure that account has the permissions you need. For full details on registering a client and the available scopes, see the Zoho Analytics API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Base URL	Yes	No	API base URL.
Authorization URL	No	No	The URL endpoint where users authenticate and authorize access.
Client ID	Yes	Yes	A unique public identifier assigned to your application.
Token URL	No	No	The URL endpoint where authorization codes are exchanged for access tokens.
Client Secret	No	Yes	A private key used to authenticate your application when requesting tokens.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter the Base URL for your Zoho Analytics data center (for example, the US host https://analyticsapi.zoho.com/restapi/v2). The Authorization URL and Token URL default to Zoho's OAuth endpoints and can be left as-is for the US data center, or adjusted to match your region.

4. Enter the Client ID and Client Secret from the OAuth client you registered in the Zoho API Console. You obtained these values in Prerequisites.

5. Complete the OAuth authorization when prompted. You will be redirected to Zoho to sign in and grant access, after which Nexla stores the resulting tokens for use by this credential.

   Access is scoped to the workspaces and organizations available to the Zoho account you authorize with. If your Client Secret is compromised, regenerate it in the Zoho API Console and update this credential.

6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Zoho Analytics Metadata API connector tile, then select the credential that will be used to connect to Zoho Analytics, and click Next; or, create a new Zoho Analytics Metadata API credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest metadata from common Zoho Analytics endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Some endpoints require a Workspace ID to be supplied when the source is configured. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Users

Retrieve users from Zoho Analytics metadata api.

• This endpoint returns the users associated with your Zoho Analytics account, including their identifiers and access details.

[Rest API] List Workspaces

Retrieve workspaces from Zoho Analytics metadata api.

• This endpoint returns the workspaces owned by the authorizing account. Workspace identifiers returned here can be used to configure the endpoints that require a Workspace ID.

[Rest API] List Organizations

Retrieve organizations from Zoho Analytics metadata api.

• This endpoint returns the organizations available to the authorizing Zoho account.

[Rest API] List Views

Retrieve views from Zoho Analytics metadata api.

• This endpoint returns the views (tables, reports, and dashboards) within a workspace. Supply the Workspace ID for the workspace whose views you want to fetch.

[Rest API] List Dashboards

Retrieve dashboards from Zoho Analytics metadata api.

• This endpoint returns the dashboards owned by the authorizing account.

[Rest API] List Trash

Retrieve trash from Zoho Analytics metadata api.

• This endpoint returns the views currently in the trash for a workspace. Supply the Workspace ID for the workspace whose trash you want to fetch.

[Rest API] List Workspace Users

Retrieve workspace_users from Zoho Analytics metadata api.

• This endpoint returns the users who have access to a specific workspace. Supply the Workspace ID for the workspace whose users you want to fetch.

[Rest API] List Folders

Retrieve folders from Zoho Analytics metadata api.

• This endpoint returns the folders within a workspace. Supply the Workspace ID for the workspace whose folders you want to fetch.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Zoho Analytics Metadata API data sources can also be manually configured to ingest data from any valid Zoho Analytics API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Zoho Analytics Metadata API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Zoho Analytics destination, and select the Send to Destination option from the menu. Select the Zoho Analytics Metadata API connector from the list of available destination connectors, then select the credential that will be used to connect to Zoho Analytics, and click Next; or, create a new Zoho Analytics Metadata API credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Zoho Analytics endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Each of these endpoints requires a Workspace ID, and the row-level endpoints also require a View ID, to identify the target table. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Import Data

Import bulk data rows into a workspace table in Zoho Analytics.

• This endpoint sends records from your Nexset as JSON to bulk-load rows into a table in the target workspace. Supply the Workspace ID for the destination workspace.

[Rest API] Add Row

Add a new row to a view (table) in Zoho Analytics.

• This endpoint sends each record from your Nexset as a new row in the target view. Supply the Workspace ID and the View ID that identify the destination table.

[Rest API] Update Row

Update an existing row in a view (table) in Zoho Analytics.

• This endpoint updates existing rows in the target view using records from your Nexset. Supply the Workspace ID and the View ID that identify the target table.

[Rest API] Delete Row

Delete rows from a view (table) in Zoho Analytics.

• This endpoint deletes rows from the target view based on records from your Nexset. Supply the Workspace ID and the View ID that identify the target table.

Manual configuration

Zoho Analytics Metadata API destinations can also be manually configured to send data to any valid Zoho Analytics API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Zoho Analytics APIs expect JSON in the request body. For update and delete operations, include the Workspace ID and View ID that identify the target table in the endpoint configuration.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Zoho Analytics endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Zoho Analytics endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.