Zoho Analytics · Node.js
Introduction
The Node.js client for Zoho Analytics REST API v2 — 215 methods across five scoped surfaces.
The Zoho Analytics Node.js client wraps REST API v2. It carries your OAuth credentials, keeps the access token alive, and exposes the API as four scoped instances hanging off one client object.
Start here#
- Getting started — install, construct a client, make a first call.
- Authentication — OAuth, scopes, data centers, and the token throttle.
- Configuration — timeouts, proxies, custom headers, regions.
- Errors — the response envelope, HTTP statuses, and the codes worth branching on.
- Limits — throttles, concurrency guards and plan quotas.
Guides#
- Importing data — synchronous, batched and job-based imports.
- Exporting data — synchronous export and the asynchronous job flow.
API reference#
| Surface | Scope |
|---|---|
| AnalyticsClient | Credentials, transport settings, instance factories. |
| OrgAPI | Users, roles, admins, subscription, security controls. |
| WorkspaceAPI | Views, folders, tags, schedules, alerts, backups, sharing. |
| ViewAPI | Rows, columns, formulas, publishing, per-view metadata. |
| BulkAPI | Import and export, synchronous and asynchronous. |
Conventions in this SDK#
| Method naming | camelCase. |
| Identifiers | string. |
| Failure surface | A rejected Promise carrying errorCode and errorMessage. |
| Source | nodejs/source/AnalyticsClient.js |
| Sample program | nodejs/sample/dummytest.js |