Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace

Zoho Analytics has been recognized in the 2024 Gartner® Magic Quadrant™ for ABI PlatformsRead more

Skip to main content

Custom Modules

Custom modules are user- defined modules in the source application that handle specific types of information or data that are not available in the pre-built modules of the source application.

Custom Modules - API Configuration

This section allows you to configure the API process for custom modules.

  • Step Name: Provide a suitable name for the API configuration of custom modules. This will help you track and distinguish the different API calls.
  • Base URL: A Base URL is the foundational part of a web address (URL) that remains the same across multiple requests or endpoints in a web application. It serves as the starting point for all API calls Provide the base URL to which the request should be sent.. Eg: https://api.example.com/
  • Method: Choose the method, Get or Post to receive the response from the source application.
  • Response Type: Choose the format in which the data should be returned by the server in response to an API request.

Parameters

  • Query parameters are parameters that are included in the URL of a request. Query parameters are appended to the URL after a question mark (?) and separated by ampersands (&) if there are multiple parameters. For example, in the URL https://api.example.com/users?username=jane_doe & status=active, username and status are query parameters. 
  • A header parameter in HTTPS requests is a key-value pair that is sent in the request header to provide information about the request or client. These headers help the server understand the context of the request, handle authentication, or provide metadata.
  • URL-encoded form data is used primarily in POST requests to send data in the body of the request. It is also encoded in key-value pairs, but it is not part of the URL.

Time Period

Records in the custom module might get frequently updated, and the Time Period section allows you to define the parameter settings to fetch the new and updated records added to the custom module dynamically.
 

  1. Choose the method in which the request should be sent from the Send As drop-down menu.
  2. Specify the Parameter Name and Values.
  3. Specify the Date Format.
  4. Granularity lets you define the time intervals for fetching data, while values specify the exact range, such as retrieving data for the past year or the last month.

Responses

This section allows you to configure the fields or columns of the custom module. Specify the Field Name and the corresponding Path. Click the Add icon to include more fields.

Transformation

API responses received from the server (resource applications) can follow different formats and structure. The transformation sections allow you to change the format of the responses received to the desired format.

  1. Choose the Format Type from the drop-down menu.
  2. Specify the required details applicable for the chosen format.

The following are the transformation options available:

  • JSON Array to String: Specify the Path for which the transformation should be applied. Specify the Delimter that separates the data and the Key. Select the checkbox Allow duplicate values 
  • JSON Array to JSON Object: Specify the Path and the JSON Object Key.
  • JSON Object Array to JSON Object: Specify the Path and the JSON Object Key.
  • JSON Object to JSON Object Array: Specify the Path and the JSON Object Key.
  • JSON Array to String: Specify the Path, Child Key Name, and Parent Key Name.
  • Change Data Format: Specify the Path and the Date Format in the response, Date format to Convert, and the Timezone.

Pagination

Pagination is a process that enables you to break up the number of records that are returned from a retrieve API action into more manageable sizes. It allows you to import data in batches.

Custom Pagination

Custom Pagination allows you to configure the rules and parameters to be used for pagination. It provides greater flexibility and control over the pagination process. Custom pagination can define specific conditions that indicate when to stop fetching data. 

End Condition: 
  • Type: Choose the condition based on which the data fetch should be stopped from the drop-down menu.
  • Look in: Indicates the location or field in the data where the pagination parameters should be applied.
  • End Condition Path: Specify the End Condition Path.
  • Comparator: Choose the Comparator value for pagination.
  • End Condition Value: Specify the End Condition Value.
Iteration Logic

Iteration Logic allows you to configure how to send the parameters in an HTTPS request. Choose the method in which the request should be sent from the Send As drop-down menu and specify the Parameter Name and Path.

Page Number

You can use this option when your data is stored in multiple pages and you want to import them in the same sequence into Zoho Analytics.

General
  • Limit: The Limit specifies how many records should be fetched in one request. For example, if you set a limit of 100, the API will return up to 100 records per request/page.
  • End Condition Path: This defines the point at which the pagination should stop. It’s often based on a field in the API response, such as a boolean flag (has_more) or checking if there are no further pages to fetch (next_page is null). This ensures the system knows when to terminate the request cycle.
Iteration Logic

Iteration Logic allows you to configure how to send the parameters in an HTTPS request. Choose the method in which the request should be sent from the Send As drop-down menu and specify the Parameter Name.

Next Page URL

The Next Page URL is used to retrieve or fetch the next set of data when the results are split across multiple pages.

  • In the Look In field, specify whether the response can be found in the request's response headers or response body.
  • Specify the Path to identify the page's URL.

Offset

Offset pagination fetches the subset of records based on the offset parameters. This works by defining an offset (starting point) and a maximum number of records (limit) to return, facilitating efficient data retrieval across multiple pages.

General 
  • In the Limit option, specify the maximum number of records to be fetched in one request.
  • Specify the End Condition Path that determines when pagination should stop.
Iteration Logic

Iteration Logic allows you to configure how to send the parameters in an HTTPS request.

  • Choose the method in which the request should be sent from the Send As drop-down menu.
  • Specify the Parameter Name.

Entities Configuration

Entities Configuration allows you to define or map the level from which the data should be fetched for the custom module. Please note that this is not a mandatory step.

  1. Select the Entity Name from the drop-down menu.
  2. Specify the number of records to be fetched in one API call in the Count Per Call field.
  3. Choose the format in which the records should be rendered from the Input Type drop-down menu.
x
Thanks for your interest. We shall get back to you shortly.