{"info":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","description":"

The Whitelabel DataPrep REST APIs workspace represents a curated collection of endpoints designed to help developers seamlessly integrate and automate data preparation workflows. This workspace acts as a unified hub where you can explore and utilize the full capabilities offered by the DataPrep platform.

Inside the REST APIs collection, you’ll find all essential endpoints required to manage workspaces, pipelines, data imports, transformations, and more. After forking the collection, ensure that you complete the necessary OAuth configuration steps to enable smooth and secure authentication.

For any questions, feedback, or suggestions, feel free to contact our support team at support@zohodataprep.com

Note: The first six APIs are supported across US, AU, IN, JP, EU, CA, and SA DCs. All remaining APIs are currently supported only in the US DC.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38020693","collectionId":"853bb2ac-4601-4412-8ff8-d96fae666b73","publishedId":"2sBXVcnDKu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-01-05T12:20:44.000Z"},"item":[{"name":"OAuth","item":[],"id":"4ea83d4e-187a-4a06-9336-6a13703d8918","description":"

The White‑labelled Zoho DataPrep REST API documentation enables developers to automate and manage data preparation workflows programmatically. It supports key actions such as creating and managing pipelines, importing and exporting data, scheduling and triggering runs, tracking job status, and integrating Zoho DataPrep capabilities into custom and white‑label applications.

Prerequisites

1. All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
2. Use your White labelled Zoho DataPrep domain in the API request URL. (e.g. dataprep.sample.com)

3. Users must hold a valid White labelled Zoho DataPrep account to use the API. If you are interested in using Zoho DataPrep as a white label solution, please write to our team. We will get in touch with you at the earliest.

OAuth 2.0 Overview

With OAuth 2.0, you can authorize third-party applications to securely use White labelled Zoho DataPrep's server resources. White labelled Zoho DataPrep provides a Client ID and a Client Secret to identify the application. The credentials are then used to request an authorization code which is used to generate an access token. All future requests to White labelled Zoho DataPrep can be carried out using this access token as a form of authorization.

Client ID and Client Secret for Third-Party apps

You will need to register your application with the White Labelled Zoho DataPrep console to get the Client ID and Client Secret.

To register your application:

Navigate to the White labelled Zoho DataPrep Console.
https://{whitelabel_domain}/accounts/console/user/{portal_id}
\n
Eg. https://dataprep.sample.com/accounts/console/user/101014xxxxx
\n

You can find the Portal ID in your White labelled Zoho DataPrep account, by clicking the profile icon at the top-right corner.

2. Click the Get Started button to create a new Client.

\n\n

3. Choose your client type. For example, select Server based if your application is a server-based application.

\n\n

4. Provide the Client Name (any random name), the Home Page URL, and the Authorized Redirect URLs, then click Create.

Note: The redirect URL is the callback entry point of your application.

\n\n

5. After the Create New Client form is submitted successfully, the Client ID and Client Secret will be provided. Now you can use this ID and the secret key to authorize your application.

\n\n

Once successfully created, the client is shown as below and you can start using the Client ID and Client Secret to authorize the API requests. You can edit or remove the client from this screen in case there are any changes to your application.

\n\n

Authorization

Launch the below URL in the browser with the appropriate parameters to obtain the authorization.

<Accounts_URL>/oauth/v2/auth?client_id=<client_id>&response_type=code&redirect_uri=https://oauth.pstmn.io/v1/browser-callback&access_type=offline&state=123&prompt=consent&scope=zohodataprep.dataprepapi.CREATE,zohodataprep.dataprepapi.UPDATE,zohodataprep.dataprepapi.DELETE,zohodataprep.dataprepapi.READ\n\n

For Example:

GET oauth/v2/auth
Host: https://dataprep.sample.com/accounts/op/1010140xxxx

Query string : https://dataprep.sample.com/accounts/op/1010140xxxx/oauth/v2/auth?client_id=1000.7U``_****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*6H_

&response_type=code

_&redirect_uri=https://oauth.pstmn.io/v1/browser-callback_

_&access_type=offline_

&state=1**&prompt=consent&scope=zohodataprep.dataprepapi.READ

The authorization URL can contain the following parameters in the query string:

Mandatory parameters are highlighted with * asterisk.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Value
*Accounts_URL	String	This is the URL of the API endpoint that deals with the user accounts.	https://{whitelabel_domain}/accounts/op/{portal_id} For example, https://dataprep.sample.com/accounts/op/1010140xxxx
*client_id	Unique identifier	The ID that was assigned to your app when you registered it.	For example, 1000.53****ZH
*response_type	String	This informs the authorization server of the desired authorization processing flow and the format in which the response should be made. Code, token, and token_id are commonly denoted response formats. We use the standard \"code\" response format for OAuth 2.0.	code
*redirect_url	URL	The callback URL that was used during client id registration.	For example https://oauth.pstmn.io/v1/browser-callback
*scope	String	Specifies the scope allowed for your app. Multiple values can be specified, separated by a comma.	For example: zohodataprep.dataprepapi.READ, zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE
access_type	String	The \"online\" access_type gives your application only the access token which is valid for one hour. The \"offline\" access_type will give the application an access_token as well as a refresh_token. You can choose the offline mode, if you need the refresh token. Refresh token can be used to obtain new access tokens for continued use of the APIs without user intervention.	offline/online (Default value: online).
prompt	String	Consent Prompts for user consent each time your app tries to access user credentials.	consent

When this Authorization URL is called, the user is shown a 'User consent page'.

\n\n

When the user clicks the Accept button,

White Labelled Zoho DataPrep redirects the user back to your application, specifically the redirect URL that is registered while creating the client through the developer console. This response will contain the 'Authorization code'.

From the address bar of your browser, copy the code displayed between \"code=\" and \"&location\" from the URL.

Example: code=1000.736bb8eccbf65f03b7d5b9f125cf3a3c.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Important: The code is valid only for two minutes.

\n\n

Your application can now request to get an Access Token using the authorization code. Copy the code from the browser.

Sample

https://oauth.pstmn.io/v1/browser-callback?state=123&code=1000.764d**********************38dc1&location=us&accounts-server=https://accounts.zoho.com&\n\n

If the user clicks the Reject button, the server returns an error saying 'access denied'.

Sample response

https://oauth.pstmn.io/v1/browser-callback?state=123&error=access_denied

Scope

OAuth 2.0 scopes provide a way to limit the amount of access that is granted to an access token. For example, an access token issued to a client app may be granted only READ access for protected resources. You can implement your APIs to enforce any scope or a combination of scopes that you wish.

\n\n

You can prompt the user to re-authorize your application every time an authorization request is sent by adding the prompt=consent parameter in the authorization URL.

A Refresh Token will always be generated by the prompt=consent parameter. The authorization server will invalidate the old refresh token and generate a new refresh token with every request for a new access token. The access_type=offline should also be included in the request.

The maximum number of Refresh Tokens is 20. Once this limit is reached, the first Refresh Token generated will be deleted.

Note:

Include prompt=consent only when necessary, like generating the refresh token, as the server may not need to prompt the user every time if they have already consented to specific scopes.

Access Token

Once your application receives the authorization code, a new request can be made to receive an Access Token using which your application will be authorized to access the data present in the White Labelled Zoho DataPrep.

Open your terminal and enter the below command.

Sample request

curl -X POST --data \"code=<code_fetched_from_request_param>&client_id=<client_id>&client_secret=<client_secret>&grant_type=authorization_code&state=1234&redirect_uri=https://oauth.pstmn.io/v1/browser-callback\" <Accounts_URL>/oauth/v2/token\n\n

Query String

curl -X POST --data ?code=1000.****f160 &grant_type=authorization_code &client_id=1000.R2Z0W**\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*Q5EN &client_secret=39c**921b &redirect_uri=https://oauth.pstmn.io/v1/browser-callback

The request URL should contain the following parameters as a query string:

Mandatory parameters are highlighted in *asterisk.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Sample Value
*code	String	Authorization code obtained from the initial request.	For example, 1000.c0**60
*client_id	Unique Identifier	The ID that was assigned to your application when you registered it.	For example, 1000.YP*_\\_FH
*client_secret	String	Your application's secret code. Assigned when you register your app, which is available in your profile.	For example, ec**27
*redirect_uri	URL	The callback URL given during the time of your application's registration.	For example, https://oauth.pstmn.io/v1/browser-callback
grant_type	String	The authorization code grant type is used by confidential and public clients to exchange an authorization code for an access token.	authorization_code
Accounts_URL	String	This is the URL of the API endpoint that deals with the user accounts.	https://{whitelabel_domain}/accounts/op/{portal_id} For example, https://dataprep.sample.com/accounts/op/1010140xxxx

Sample Response

Once the request along with the authorization code is sent, White Labelled Zoho DataPrep will issue a response to your application like the one shown below.

{\n\"access_token\":\"1000.e9*****************************cd\",\n\"refresh_token\":\"1000.61****************************05\",\n\"token_type\":\"Bearer\",\n\"expires_in_sec\":3600,\n\"scope\":\"zohodataprep.dataprepapi.CREATE zohodataprep.dataprepapi.UPDATE zohodataprep.dataprepapi.DELETE zohodataprep.dataprepapi.READ\",\n\"expires_in\": 3600000`\n}\n\n

The response gives the following information:

expires_in_sec - Duration in seconds for which the token remains valid.
\n
scope - The scope allowed for your application. Multiple values can be specified, separated by a comma.
\n
token_type - Type of token. (\"Bearer\")
\n
access_token - Access Token for the user. This token can be used for the API calls and will be valid only for an hour.
\n
refresh_token - Refresh Token is used when the Access Token has expired. This token is permanent and can be used multiple times to refresh the app and get a new Access Token.
\n

You can store this data so that there is no need to prompt the users for authorization each time an API request is made from your app.

Using the Access Token

Send the Access Token as a header when you call White Labelled Zoho DataPrep's REST API.

Example

GET oauth/user/info

Query String

GET
HOST: https://dataprep.sample.com/accounts/op/1010140xxxx/
Header: Authorization= Zoho-oauthtoken

When this Access Token with the available scopes invokes the URL, the information within the scope is granted to the application.

Access Token Expiry

The Access Tokens have limited validity. In most cases, the Access Token expires in one hour. Once it expires, your app will have to use the Refresh Token to request a new Access Token.

Sample request

curl -X POST --data \"code=<code_fetched_from_browser>&client_id=<client_id>&client_secret=<client_secret>&grant_type=authorization_code&state=1234&redirect_uri=https://oauth.pstmn.io/v1/browser-callback\" <Accounts_URL>/oauth/v2/token\n\n

Query String

curl -X POST --data

?code=1000.****f160

&grant_type=authorization_code

&client_id=1000.R2Z0W_\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\_Q5EN

&client_secret=39c**921b

&redirect_uri=https://oauth.pstmn.io/v1/browser-callback

Refresh Access Token

Access tokens expire after an hour of generation. To generate a new access token, use the refresh token you generated earlier.

Open your terminal and make a post request with the below command:

curl -X POST <Accounts_URL>/oauth/v2/token?\"refresh_token=<refresh_token>&client_id=<client_id>&client_secret=<client_secret>&grant_type=refresh_token\"\n\n

Query string

curl -X POST

{Accounts_URL} - https://dataprep.sample.com/accounts/op/1010140xxxx

?refresh_token=1000.****701

&client_id=1000.R2Z0W****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*Q5EN

&client_secret=39c**921b

&grant_type=refresh_token

The request URL should contain all the following parameters as a query string:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Sample Value
Accounts_URL	String	This is the URL of the API endpoint that deals with the user accounts.	https://{whitelabel_domain}/accounts/op/{portal_id} For example, https://dataprep.sample.com/accounts/op/1010140xxxx
refresh_token	String	The Refresh Token is provided along with the Access Token.	For example, 1000.4069dacb56****bcf902062390367
client_id	Unique Identifier	The ID that was assigned to your app when you registered it.	For example, 1000.R2Z0W_*\\__\\_Q5EN
client_secret	String	Your app's secret. Assigned when you register your app and available in your profile.	For example, 39c**921b
grant_type	String	The Refresh Token grant type is used by clients to exchange a refresh token for an access token when the access token has expired.	refresh_token

Sample response:

If the request is successful, you will receive the following output:

{\n                \"access_token\": \"{new_access_token}\",\n                \"expires_in\": 3600,\n                \"token_type\": \"Bearer\"\n }\n\n

The response gives the following information:

expires_in_sec - Duration in seconds for which the token remains valid.
\n
token_type - Type of token. (\"Bearer\")
\n
access_token - Access Token for the user. This token can be used for API calls and will be valid only for an hour.
\n

You will now receive a new Access Token using which you can continue getting the access provided by the user. This Access Token will also have a time limit of one hour. You will have to repeat this process when the access token expires.

Revoking a Refresh token

You may choose to revoke a refresh token when you no longer need access to data for a particular scope. To revoke a refresh token, you must send a revoke token request.

Sample request

<accounts_URL>/oauth/v2/token/revoke?token=<refresh_token>\n\n

Note: If you are a JavaScript application client, you can revoke an access token using the same request.

Sample response

{\n\"status\": \"success\"\n}\n\n

If the refresh token is invalid, the revoke token request will not be executed and you will receive an HTTP status error code 400.

To learn more about OAuth 2.0. visit this help page.

Possible error codes

This section lists all possible error response codes that could be sent from the White Labelled Zoho DataPrep server on the failure of APIs. You can use this for appropriate error handling.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Description	HTTP response code
4001	Invalid Input	400
4002	Forbidden / User not allowed to perform the operation	403
4004	Internal Error (Exact error cannot be sent to a user, like an Exception)	500
4007	Invalid URL or Resource not found, e.g : /requests/10, and if the request with id 10 is not found	404
4011	No such field	400
4012	Value for mandatory field is not provided	400
4013	Unsupported Content Type	415
4015	API Rate Limit Reached	400
4016	Already In trash	400
4017	Not In Trash	400
4018	Trying to add a record after the number of records has reached the tuple limit	400
4019	The user is not authorized	400

In case of any error other than the above said, mail the API request URL parameters and error response details to support@zohodataprep.com. Zoho DataPrep Team will get back to you with the best possible solution.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"scope","value":""},{"key":"clientId","value":""},{"key":"clientSecret","value":""},{"key":"useBrowser","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"b9cfbcd4-d6e7-4afc-9ec2-cad8ee55d33b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"0466386d-c6bc-4837-9ecf-1c32a31f016d"}}],"_postman_id":"4ea83d4e-187a-4a06-9336-6a13703d8918"},{"name":"V1","item":[{"name":"Organisation ID","id":"6b7ac8d0-c6fa-43c7-a95e-fcbb5db48e33","protocolProfileBehavior":{"disabledSystemHeaders":{"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/list_organizations","description":"

This API lists all the organizations in which a user is an Account admin, or an Organization admin, or a shared user.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","list_organizations"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[]}},"response":[{"id":"1dbffb5c-2e64-46a8-9bba-322086b3c52d","name":"Organisation ID","originalRequest":{"method":"GET","header":[],"url":"https://dataprep.sample.com/api/v1/list_organizations"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"ZGS"},{"key":"Date","value":"Thu, 20 Nov 2025 07:02:29 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"369"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Set-Cookie","value":"zohodataprep=c5af9458-02d5-4add-b221-133bc5efca27;path=/;Secure;priority=high"},{"key":"Set-Cookie","value":"_zcsr_tmp=c5af9458-02d5-4add-b221-133bc5efca27;path=/;SameSite=Strict;Secure;priority=high"},{"key":"Set-Cookie","value":"Secure;HttpOnly;SameSite=Lax"},{"key":"Cache-Control","value":"private,no-cache,no-store,max-age=0,must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Access-Control-Allow-Origin","value":"https://*.zoho.com"},{"key":"Expect-CT","value":"max-age=30, enforce"},{"key":"Strict-Transport-Security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"portalsetting\": {\n \"portal\": [\n {\n \"PORTAL_OWNER\": 10104***017,\n \"PORTAL_NAME\": \"samplewl\",\n \"display_name\": \"samplewl\",\n \"portal_name\": \"samplewl\",\n \"bundle_org_id\": \"samplewl\",\n \"ORG_NAME\": \"samplewl\",\n \"zid\": 10101402***,\n \"zaaid\": 10101402***,\n \"admin_zuids\": [\n 10104***017\n ]\n }\n ]\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n ]\n }\n}"}],"_postman_id":"6b7ac8d0-c6fa-43c7-a95e-fcbb5db48e33"},{"name":"All workspaces","id":"fbe30504-b77f-4a34-91ab-f74c0e911122","protocolProfileBehavior":{"disabledSystemHeaders":{"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portalname}}/list_workspaces","description":"

This API is used to list all the workspaces in an organization in which the user is an Account admin, or an Organization admin, or a shared user.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Query parameters
To navigate around the data from response, list_info can be provided in the input data (optional). Here's a sample of the input data with list_info:

Sample input: Note: Please make sure the input data is encoded if provided.

input_data: {\"list_info\":{\"start_index\":1,\"row_count\":100,\"sort_field\":\"modtime\",\"sort_order\":\"desc\",\"scope\":\"owned\"}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables	Description
start_index	integer	If you have 100 items in a list, the start index value can be anything from 1 to 98.	This indicates the position in the list from where the API should sort and return results.
row_count	integer	max 100	This value indicates the total number of items in a list.
sort_field	string	`name` `modtime created_time`	The field name based on which you would like to sort. Name, modified date, created date.
sort_order	string	`asc` `desc`	The order in which you would like to sort- Ascending or descending.

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portalname}}","list_workspaces"],"host":["{{whitelabel_domain}}"],"query":[{"disabled":true,"description":{"content":"

sample input

\n","type":"text/plain"},"key":"input_data","value":"input_data%3A%20%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22modtime%22%2C%22sort_order%22%3A%22desc%22%2C%22scope%22%3A%22owned%22%7D%7D"}],"variable":[{"id":"cebe1b4b-bc1d-4ef5-9a2a-d139c0886435","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portalname}}"}]}},"response":[{"id":"fc037b0b-dce9-4da1-a7a8-c46a5991548c","name":"All workspaces","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dataprep.sample.com/api/v1/portals/samplewl/list_workspaces?input_data=input_data%3A%20%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22modtime%22%2C%22sort_order%22%3A%22desc%22%2C%22scope%22%3A%22owned%22%7D%7D","protocol":"https","host":["dataprep","sample","com"],"path":["api","v1","portals","samplewl","list_workspaces"],"query":[{"key":"input_data","value":"input_data%3A%20%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22modtime%22%2C%22sort_order%22%3A%22desc%22%2C%22scope%22%3A%22owned%22%7D%7D","description":"sample input","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"ZGS"},{"key":"Date","value":"Thu, 20 Nov 2025 11:39:09 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private,no-cache,no-store,max-age=0,must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Access-Control-Allow-Origin","value":"https://*.zoho.com"},{"key":"Expect-CT","value":"max-age=30, enforce"},{"key":"Set-Cookie","value":"Secure;HttpOnly;SameSite=Lax"},{"key":"vary","value":"accept-encoding"},{"key":"Strict-Transport-Security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"Follow the below steps to find the Workspace ID from the sample response:\n1. Search \"name\" in the response, and navigate to the Workspace name.\n2. Above the workspace name, you will find the \"id\" key and the corresponding value is the Workspace ID. \n\n\n{\n \"projects\": [\n {\n \"id\": \"55317000000022175\",\n \"name\": \"My Workspace-3\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000003521\",\n \"zuid\": \"101015***66\",\n \"username\": \"Zylker\",\n \"email_id\": \"Zylker@zohotest.com\",\n \"invited_time\": \"1751972243032\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=*******&fs=thumb\"\n },\n \"created_time\": \"1763376926277\",\n \"modified_by\": {\n \"id\": \"55317000000003521\",\n \"zuid\": \"1010153****\",\n \"username\": \"Zylker\",\n \"email_id\": \"Zylker@zohotest.com\",\n \"invited_time\": \"1751972243032\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101402532\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10101*******&fs=thumb\"\n },\n \"modtime\": \"1763468154804\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false,\n \"permissions\": {\n \"PROJECT_CREATE\": true,\n \"PROJECT_READ\": true,\n \"PROJECT_UPDATE\": true,\n \"PROJECT_DELETE\": true,\n \"DATASET_CREATE\": true,\n \"DATASET_READ\": true,\n \"DATASET_UPDATE\": true,\n \"DATASET_DELETE\": true,\n \"RSTEMPLATE_CREATE\": true,\n \"RSTEMPLATE_READ\": true,\n \"RSTEMPLATE_UPDATE\": true,\n \"RSTEMPLATE_DELETE\": true,\n \"PORTAL_CREATE\": false,\n \"PORTAL_SETTINGS\": false,\n \"USER_MANAGEMENT\": true,\n \"RESTAPI\": false,\n \"SCHEDULING\": true,\n \"SHARING\": true,\n \"DATASET_READY\": true,\n \"AUDIT_TRAIL\": true,\n \"AUDIT\": true,\n \"FORMULA_ENGINE\": true,\n \"MANAGE_ADMIN\": true,\n \"DATA_RELOAD\": true,\n \"DATABRIDGE_ACCESS\": true,\n \"USAGE_BREAKDOWN\": false,\n \"OPEN_AI\": false,\n \"WHITELABEL\": false,\n \"PLTEMPLATE_CREATE\": true,\n \"PLTEMPLATE_READ\": true,\n \"PLTEMPLATE_UPDATE\": true,\n \"PLTEMPLATE_DELETE\": true,\n \"PIPELINE_CREATE\": true,\n \"PIPELINE_READ\": true,\n \"PIPELINE_UPDATE\": true,\n \"PIPELINE_DELETE\": true,\n \"ADMIN_TOOL\": false,\n \"DEBUG_TOOL\": false,\n \"PORTAL_ACCESS\": true,\n \"LOGO_REBRANDING\": false,\n \"GROUP_CREATE\": true,\n \"GROUP_READ\": true,\n \"GROUP_UPDATE\": true,\n \"GROUP_DELETE\": true,\n \"GDPR_PII\": true,\n \"DATA_DEPULICATION_COLUMN\": true,\n \"DATA_DEPULICATION_ROW\": true,\n \"PERSONALISED_ENTITY_TYPE\": true,\n \"CUSTOM_DATA_EXTRACTION_USING_FORMULA_SCRIPTING\": true,\n \"JOIN_UNION\": true,\n \"GIS_INFO_FROM_ZIP\": true,\n \"COUNTRY_INFO_FROM_GIS\": true,\n \"NOTIFY_SYNC_FAILURE\": true,\n \"COMPLETE_DATASET_AUDIT\": true,\n \"AUDIT_LOGS\": false,\n \"HIPAA\": false,\n \"CONNECTION_CREATE\": true,\n \"CONNECTION_READ\": true,\n \"CONNECTION_UPDATE\": true,\n \"CONNECTION_DELETE\": true,\n \"TAGS\": true,\n \"TARGET_MATCH\": true,\n \"CUSTOM_DATATYPES\": true,\n \"SHARE_TO_SUPPORT\": false\n }\n },\n {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"1011079****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763381847660\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"1011079****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modtime\": \"1763620083284\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false,\n \"permissions\": {\n \"PROJECT_CREATE\": true,\n \"PROJECT_READ\": true,\n \"PROJECT_UPDATE\": true,\n \"PROJECT_DELETE\": true,\n \"DATASET_CREATE\": true,\n \"DATASET_READ\": true,\n \"DATASET_UPDATE\": true,\n \"DATASET_DELETE\": true,\n \"RSTEMPLATE_CREATE\": true,\n \"RSTEMPLATE_READ\": true,\n \"RSTEMPLATE_UPDATE\": true,\n \"RSTEMPLATE_DELETE\": true,\n \"PORTAL_CREATE\": false,\n \"PORTAL_SETTINGS\": false,\n \"USER_MANAGEMENT\": true,\n \"RESTAPI\": false,\n \"SCHEDULING\": true,\n \"SHARING\": true,\n \"DATASET_READY\": true,\n \"AUDIT_TRAIL\": true,\n \"AUDIT\": true,\n \"FORMULA_ENGINE\": true,\n \"MANAGE_ADMIN\": true,\n \"DATA_RELOAD\": true,\n \"DATABRIDGE_ACCESS\": true,\n \"USAGE_BREAKDOWN\": false,\n \"OPEN_AI\": false,\n \"WHITELABEL\": false,\n \"PLTEMPLATE_CREATE\": true,\n \"PLTEMPLATE_READ\": true,\n \"PLTEMPLATE_UPDATE\": true,\n \"PLTEMPLATE_DELETE\": true,\n \"PIPELINE_CREATE\": true,\n \"PIPELINE_READ\": true,\n \"PIPELINE_UPDATE\": true,\n \"PIPELINE_DELETE\": true,\n \"ADMIN_TOOL\": false,\n \"DEBUG_TOOL\": false,\n \"PORTAL_ACCESS\": true,\n \"LOGO_REBRANDING\": false,\n \"GROUP_CREATE\": true,\n \"GROUP_READ\": true,\n \"GROUP_UPDATE\": true,\n \"GROUP_DELETE\": true,\n \"GDPR_PII\": true,\n \"DATA_DEPULICATION_COLUMN\": true,\n \"DATA_DEPULICATION_ROW\": true,\n \"PERSONALISED_ENTITY_TYPE\": true,\n \"CUSTOM_DATA_EXTRACTION_USING_FORMULA_SCRIPTING\": true,\n \"JOIN_UNION\": true,\n \"GIS_INFO_FROM_ZIP\": true,\n \"COUNTRY_INFO_FROM_GIS\": true,\n \"NOTIFY_SYNC_FAILURE\": true,\n \"COMPLETE_DATASET_AUDIT\": true,\n \"AUDIT_LOGS\": false,\n \"HIPAA\": false,\n \"CONNECTION_CREATE\": true,\n \"CONNECTION_READ\": true,\n \"CONNECTION_UPDATE\": true,\n \"CONNECTION_DELETE\": true,\n \"TAGS\": true,\n \"TARGET_MATCH\": true,\n \"CUSTOM_DATATYPES\": true,\n \"SHARE_TO_SUPPORT\": false\n }\n }\n ],\n \"list_info\": {\n \"sort_field\": \"id\",\n \"has_more_rows\": false,\n \"row_count\": 2,\n \"sort_order\": \"asc\"\n },\n \"response_status\": [\n {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n ]\n}"}],"_postman_id":"fbe30504-b77f-4a34-91ab-f74c0e911122"},{"name":"All pipelines in a workspace","id":"5a7f73cd-b88f-4e85-bd10-c4a65417416d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portalname}}/workspaces/:{{workspaceID}}/list_pipelines","description":"

This API is used to get all pipelines in a workspace.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Query parameters :

To navigate around the data from response, list_info can be provided in the input data (optional). Here's a sample of the input data with list_info:

Sample input

input_data: {\"list_info\":{\"start_index\":1,\"row_count\":100,\"sort_field\":\"name\",\"sort_order\":\"desc\",\"scope\":\"owned\"}}

Note: Please make sure the input data is encoded if provided.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables	Description
start_index	integer	If you have 100 items in a list, the start index value can be anything from 1 to 98.	This indicates the position in the list from where the API should sort and return results.
row_count	integer	max 100	This value indicates the total number of items in a list.
sort_field	string	`name modtime`	The field name based on which you would like to sort: pipeline name, modified date
sort_order	string	`asc` `desc`	The order in which you would like to sort- Ascending or descending.

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portalname}}","workspaces",":{{workspaceID}}","list_pipelines"],"host":["{{whitelabel_domain}}"],"query":[{"disabled":true,"description":{"content":"

sample input

\n","type":"text/plain"},"key":"input_data","value":"input_data%3A%20%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22name%22%2C%22sort_order%22%3A%22desc%22%2C%22scope%22%3A%22owned%22%7D%7D"}],"variable":[{"id":"049fe610-03b8-4583-92d7-1b6c2f917469","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portalname}}"},{"id":"d30dd47e-fa5f-482a-a7f3-77e31ae86e99","description":{"content":"

Provide your workspace ID. You can get it using the Get All workspaces API

\n","type":"text/plain"},"type":"any","value":"string","key":"{{workspaceID}}"}]}},"response":[{"id":"56426419-2b9a-425d-b999-695808c7cfc0","name":"All pipelines in a workspace","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dataprep.sample.com/api/v1/portals/samplewl/workspaces/55317000000022199/list_pipelines?input_data=input_data%3A%20%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22name%22%2C%22sort_order%22%3A%22desc%22%2C%22scope%22%3A%22owned%22%7D%7D","protocol":"https","host":["dataprep","sample","com"],"path":["api","v1","portals","samplewl","workspaces","55317000000022199","list_pipelines"],"query":[{"key":"input_data","value":"input_data%3A%20%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22name%22%2C%22sort_order%22%3A%22desc%22%2C%22scope%22%3A%22owned%22%7D%7D","description":"sample input","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"ZGS"},{"key":"Date","value":"Thu, 20 Nov 2025 11:41:28 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private,no-cache,no-store,max-age=0,must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Access-Control-Allow-Origin","value":"https://*.zoho.com"},{"key":"Expect-CT","value":"max-age=30, enforce"},{"key":"Set-Cookie","value":"Secure;HttpOnly;SameSite=Lax"},{"key":"vary","value":"accept-encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"Follow the below step to find the pipeline id from the sample response:\n1. Under the pipelines object, search \"name\" in the response, and navigate to the pipeline name.\n2. Above the pipeline name, you will find the \"id\" key, and the corresponding value is the Pipeline ID. \n\n\n{\n \"pipelines\": [\n {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modtime\": \"1763464694293\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false,\n \"permissions\": {\n \"PROJECT_CREATE\": false,\n \"PROJECT_READ\": true,\n \"PROJECT_UPDATE\": false,\n \"PROJECT_DELETE\": false,\n \"DATASET_CREATE\": true,\n \"DATASET_READ\": true,\n \"DATASET_UPDATE\": true,\n \"DATASET_DELETE\": true,\n \"RSTEMPLATE_CREATE\": true,\n \"RSTEMPLATE_READ\": true,\n \"RSTEMPLATE_UPDATE\": true,\n \"RSTEMPLATE_DELETE\": true,\n \"PORTAL_CREATE\": false,\n \"PORTAL_SETTINGS\": false,\n \"USER_MANAGEMENT\": true,\n \"RESTAPI\": false,\n \"SCHEDULING\": true,\n \"SHARING\": true,\n \"DATASET_READY\": true,\n \"AUDIT_TRAIL\": true,\n \"AUDIT\": true,\n \"FORMULA_ENGINE\": true,\n \"MANAGE_ADMIN\": true,\n \"DATA_RELOAD\": true,\n \"DATABRIDGE_ACCESS\": true,\n \"USAGE_BREAKDOWN\": false,\n \"OPEN_AI\": false,\n \"WHITELABEL\": false,\n \"PLTEMPLATE_CREATE\": true,\n \"PLTEMPLATE_READ\": true,\n \"PLTEMPLATE_UPDATE\": true,\n \"PLTEMPLATE_DELETE\": true,\n \"PIPELINE_CREATE\": false,\n \"PIPELINE_READ\": true,\n \"PIPELINE_UPDATE\": true,\n \"PIPELINE_DELETE\": true,\n \"ADMIN_TOOL\": true,\n \"DEBUG_TOOL\": true,\n \"PORTAL_ACCESS\": true,\n \"LOGO_REBRANDING\": true,\n \"GROUP_CREATE\": true,\n \"GROUP_READ\": true,\n \"GROUP_UPDATE\": true,\n \"GROUP_DELETE\": true,\n \"GDPR_PII\": true,\n \"DATA_DEPULICATION_COLUMN\": true,\n \"DATA_DEPULICATION_ROW\": true,\n \"PERSONALISED_ENTITY_TYPE\": true,\n \"CUSTOM_DATA_EXTRACTION_USING_FORMULA_SCRIPTING\": true,\n \"JOIN_UNION\": true,\n \"GIS_INFO_FROM_ZIP\": true,\n \"COUNTRY_INFO_FROM_GIS\": true,\n \"NOTIFY_SYNC_FAILURE\": true,\n \"COMPLETE_DATASET_AUDIT\": true,\n \"AUDIT_LOGS\": false,\n \"HIPAA\": false,\n \"CONNECTION_CREATE\": true,\n \"CONNECTION_READ\": true,\n \"CONNECTION_UPDATE\": true,\n \"CONNECTION_DELETE\": true,\n \"TAGS\": true,\n \"TARGET_MATCH\": true,\n \"CUSTOM_DATATYPES\": true,\n \"SHARE_TO_SUPPORT\": false\n },\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763381847660\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modtime\": \"1763620083284\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n },\n \"current_pipeline_audit\": {\n \"id\": \"55317000000022205\",\n \"created_time\": \"1763381848781\",\n \"modtime\": \"1763382052886\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false\n },\n \"status\": 1,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n }\n },\n \"pipelineschedule\": null,\n \"pipelinerun\": {\n \"id\": \"55317000000022727\",\n \"pipelineaudit\": {\n \"id\": \"55317000000022205\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"status\": 1\n },\n \"pipelinerunconfigaudit\": {\n \"id\": \"55317000000022725\",\n \"status\": 1,\n \"skip_export_invalid_data\": false,\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"pipelinefile\": {\n \"id\": \"55317000000022719\"\n }\n },\n \"execution_status\": 1,\n \"type\": 5,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763464683311\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modified_time\": \"1763464694258\",\n \"completion_time\": \"1763464694256\",\n \"data_interval_start_time\": \"1763381848767\",\n \"data_interval_end_time\": \"1763464683251\",\n \"rerun_count\": 0,\n \"profile_output\": false,\n \"skip_export_invalid_data\": false,\n \"status\": 1,\n \"pipelinerunaudit\": {\n \"id\": \"55317000000022729\",\n \"created_time\": \"1763464683318\",\n \"modtime\": \"1763464694289\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\",\n \"pipelineaudit\": {\n \"id\": \"55317000000022205\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"status\": 1\n },\n \"pipelinerunconfigaudit\": {\n \"id\": \"55317000000022725\",\n \"status\": 1,\n \"skip_export_invalid_data\": false,\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"pipelinefile\": {\n \"id\": \"55317000000022719\"\n }\n },\n \"execution_status\": 1,\n \"type\": 5,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763464683311\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modified_time\": \"1763464694258\",\n \"completion_time\": \"1763464694256\",\n \"data_interval_start_time\": \"1763381848767\",\n \"data_interval_end_time\": \"1763464683251\",\n \"rerun_count\": 0,\n \"profile_output\": false,\n \"skip_export_invalid_data\": false,\n \"status\": 1\n },\n \"status\": 1,\n \"execution_policy\": 1,\n \"execution_status\": 1,\n \"completion_time\": \"1763464694271\",\n \"storage_used\": \"213400\",\n \"row_count\": \"762\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modtime\": \"1763464694293\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763381847660\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modtime\": \"1763620083284\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n }\n }\n },\n \"storage_used\": 213400,\n \"row_count\": 762,\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modtime\": \"1763464694293\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"created_time\": \"1763381847660\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110*****\",\n \"username\": \"Zylker2\",\n \"email_id\": \"Zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110*****&fs=thumb\"\n },\n \"modtime\": \"1763620083284\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n }\n }\n },\n \"tags\": [],\n \"is_shared_to_support\": false\n }\n ],\n \"list_info\": {\n \"sort_field\": \"id\",\n \"has_more_rows\": false,\n \"row_count\": 1,\n \"sort_order\": \"asc\"\n },\n \"response_status\": [\n {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n ]\n}\n"}],"_postman_id":"5a7f73cd-b88f-4e85-bd10-c4a65417416d"},{"name":"Other automations (webhook)","id":"3499e8fa-ce82-4081-a8c5-4e102f01d029","protocolProfileBehavior":{"disabledSystemHeaders":{"connection":true,"accept-encoding":true,"user-agent":true,"content-length":true,"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"pipeline_run_config\":{\"55317000000052657\":{\"fetch_type\":\"IMPORT_SOURCE_FILE\",\"use_existing_data_if_no_new_data\":false}},\"skip_export_invalid_data\":true,\"type\":5}","description":"

example input data

\n","type":"text","uuid":"493d3b0a-0959-4839-b678-87e4491a3a20"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portalname}}/pipelines/:{{pipeline_id}}/automation","description":"

The Other Automations (Webhook) API allows the pipeline to trigger workflows automatically based on pipeline events.

Service name : zohodataprep

Scopes : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

INPUT PARAMETERS

SAMPLE INPUT data for S3/FTP for webhook run:

When imported using simple selection:

{\"pipeline_run_config\":{\"55317000000213321\":{\"fetch_type\":\"IMPORT_SOURCE_FILE\",\"use_existing_data_if_no_new_data\":false}},\"skip_export_invalid_data\":true,\"type\":5}

When imported using advanced selection: (using file pattern)

1) Import all data

{\"pipeline_run_config\":{\"55317000000205657\":{\"fetch_type\":\"IMPORT_ALL_DATA\",\"use_existing_data_if_no_new_data\":false,\"max_file_batch_size\":\"10\"}},\"skip_export_invalid_data\":true,\"type\":5}

2) Incremental file fetch

a) All files

{\"pipeline_run_config\":{\"55317000000205657\":{\"fetch_type\":\"IMPORT_MODIFIED_AND_NEW_DATA\",\"use_existing_data_if_no_new_data\":true,\"max_file_batch_size\":\"10\",\"fetch_order\":\"all\",\"fetch_based_on_column_name\":\"modifiedTime\"}},\"skip_export_invalid_data\":true,\"type\":5}

b) Newest file

{\"pipeline_run_config\":{\"55317000000205657\":{\"fetch_type\":\"IMPORT_MODIFIED_AND_NEW_DATA\",\"use_existing_data_if_no_new_data\":true,\"max_file_batch_size\":\"10\",\"fetch_order\":\"newest\",\"fetch_based_on_column_name\":\"modifiedTime\"}},\"skip_export_invalid_data\":true,\"type\":5}

c) Oldest file

{\"pipeline_run_config\":{\"55317000000205657\":{\"fetch_type\":\"IMPORT_MODIFIED_AND_NEW_DATA\",\"use_existing_data_if_no_new_data\":true,\"max_file_batch_size\":\"10\",\"fetch_order\":\"oldest\",\"fetch_based_on_column_name\":\"modifiedTime\"}},\"skip_export_invalid_data\":true,\"type\":5}

3) Do not import data

{\"pipeline_run_config\":{\"55317000000205657\":{\"fetch_type\":\"NO_DATA\",\"use_existing_data_if_no_new_data\":true},\"55317000000212289\":{\"fetch_type\":\"IMPORT_ALL_DATA\",\"use_existing_data_if_no_new_data\":false,\"max_file_batch_size\":\"10\"}},\"skip_export_invalid_data\":true,\"type\":5}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables (Possible / Example)	Description	Mandatory
`type`	Integer	`5`	Automation type identifier. `5` represents a Webhook run.	✅ Yes
`skip_export_invalid_data`	Boolean	`true`, `false` (Example: `false`)	Indicates whether invalid records should be skipped during export.	❌ No
`pipeline_run_config`	Object	Example: `{ \"\": { ... } }`	Configuration object to control data import behavior for each Import node pipeline task.	✅ Yes
`pipeline_run_config.`	Object	Example: `55317000000058437`	Unique pipeline task ID of the Import node whose data fetch behavior is being configured. Fetch this from the Pipeline Info API.	✅ Yes
`fetch_type`	String	`IMPORT_ALL_DATA`, `IMPORT_MODIFIED_AND_NEW_DATA`, `IMPORT_SOURCE_FILE`, `NO_DATA` (Example: `IMPORT_MODIFIED_AND_NEW_DATA`)	Defines how data should be imported from the source for the given Import node.	✅ Yes
`use_existing_data_if_no_new_data`	Boolean	`true`, `false` (Example: `true`)	Uses previously imported data if no new or modified data is available. Not applicable for `NO_DATA`.	❌ No
`max_file_batch_size`	Integer	Any positive integer (Example: `10`)	Maximum number of files to be processed in a single webhook run. Applicable for bulk imports.	❌ No
`fetch_order`	String	`All`	Specifies the order in which modified and new data should be fetched. Applicable only for modified data imports.	❌ No
`fetch_based_on_column_name`	String	`modifiedTime`, `createdTime` (Example: `modifiedTime`)	Column name used to identify modified records in the source. Applicable only for modified data imports.	❌ No

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portalname}}"},{"id":"bc796a2f-3797-472c-a7b8-e35185f1a3d1","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"1bafb4f1-c809-4097-932a-e2d178fef89c","name":"Other automations (webhook)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"pipeline_run_config\":{\"55317000000052657\":{\"fetch_type\":\"IMPORT_SOURCE_FILE\",\"use_existing_data_if_no_new_data\":false}},\"skip_export_invalid_data\":true,\"type\":5}","type":"text","uuid":"0a1e19ea-cb9c-4409-94c5-4e464dccb322"}]},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelines/55317000000022201/automation"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"ZGS"},{"key":"Date","value":"Thu, 20 Nov 2025 11:49:50 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"1853"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private,no-cache,no-store,max-age=0,must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Access-Control-Allow-Origin","value":"https://*.zoho.com"},{"key":"Expect-CT","value":"max-age=30, enforce"},{"key":"Set-Cookie","value":"Secure;HttpOnly;SameSite=Lax"},{"key":"Locations","value":"[\"/workspace/finepickwl/dataprepapi/pipelinetaskinstances/55317000000034013\",\"/workspace/finepickwl/dataprepapi/pipelinetaskinstances/55317000000034017\",\"/workspace/finepickwl/dataprepapi/pipelinetaskinstances/55317000000034021\",\"/workspace/finepickwl/dataprepapi/pipelinetaskinstances/55317000000034025\",\"/workspace/finepickwl/dataprepapi/pipelinetaskinstances/55317000000034029\",\"/workspace/finepickwl/dataprepapi/pipelinetaskinstances/55317000000034033\",\"/workspace/finepickwl/dataprepapi/pipelinetaskinstances/55317000000034037\"]"},{"key":"vary","value":"accept-encoding"},{"key":"Strict-Transport-Security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"Follow the below steps to find the pipelinerun_id from the sample response:\n1. Navigate to the \"pipelinerun\" object.\n2. Identify the \"id\" key right below the object. The corresponding value is the pipelinerun_id.\n\n\n{\n \"pipelinerun\": {\n \"id\": \"55317000000034001\",\n \"pipelineaudit\": {\n \"id\": \"55317000000022205\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"status\": 1\n },\n \"pipelinerunconfigaudit\": {\n \"id\": \"55317000000022725\",\n \"status\": 1,\n \"skip_export_invalid_data\": false,\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"pipelinefile\": {\n \"id\": \"55317000000022719\"\n }\n },\n \"execution_status\": 0,\n \"type\": 5,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"1011079****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"101014****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=1011079****&fs=thumb\"\n },\n \"created_time\": \"1763639390299\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"1011079****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"101014****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=1011079****&fs=thumb\"\n },\n \"modified_time\": \"1763639390669\",\n \"completion_time\": null,\n \"data_interval_start_time\": \"1763464683252\",\n \"data_interval_end_time\": \"1763639390250\",\n \"rerun_count\": 0,\n \"profile_output\": false,\n \"skip_export_invalid_data\": false,\n \"status\": 1\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n ]\n },\n \"Locations\": [\n \"/workspace/samplewl/dataprepapi/pipelinetaskinstances/55317000000034013\",\n \"/workspace/samplewl/dataprepapi/pipelinetaskinstances/55317000000034017\",\n \"/workspace/samplewl/dataprepapi/pipelinetaskinstances/55317000000034021\",\n \"/workspace/samplewl/dataprepapi/pipelinetaskinstances/55317000000034025\",\n \"/workspace/samplewl/dataprepapi/pipelinetaskinstances/55317000000034029\",\n \"/workspace/samplewl/dataprepapi/pipelinetaskinstances/55317000000034033\",\n \"/workspace/samplewl/dataprepapi/pipelinetaskinstances/55317000000034037\"\n ]\n}\n"}],"_postman_id":"3499e8fa-ce82-4081-a8c5-4e102f01d029"},{"name":"All jobs in a pipeline","id":"5a9d435e-a938-402f-b442-17690d601c7e","protocolProfileBehavior":{"disabledSystemHeaders":{"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portalname}}/jobs_list","description":"

This API is used to get all jobs in a pipeline.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Query parameters:

To navigate around the data from response, list_info can be provided in the input data (optional). Here's a sample of the input data with list_info:

Sample input
input_data: {\"list_info\":{\"start_index\":1,\"row_count\":100,\"search_criteria\":[{\"field\":\"pipelineaudit.pipeline.id\",\"value\":\"1523000000002197\",\"condition\":\"eq\"}],\"sort_field\":\"created_time\",\"sort_order\":\"desc\"}}

Note: The search_criteria parameter in list_info is mandatory as it is used to locate the jobs of a specific pipeline. Please make sure the input data is encoded.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables	Description
start_index	integer	If you have 100 items in a list, the start index value can be anything from 1 to 98.	This indicates the position in the list from where the API should sort and return results.
row_count	integer	max 100	This value indicates the total number of items in a list.
search_criteria*	string	Provide the Pipeline ID value with the \"equal to\" condition as below: `search_criteria\":[{\"field\":\"pipelineaudit.pipeline.id\",\"value\":\"{{pipeline_id}}\",\"condition\":\"eq\"}]` Note: Providing the Pipeline ID in the value field is mandatory.	The field name, condition, and pipeline id using which you want to search.
sort_field	string	`id` `created_time execution_status`	The field name based on which you would like to sort. Jobs, Start time, Status.
sort_order	string	`asc` `desc`	The order in which you would like to sort- Ascending or descending.

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portalname}}","jobs_list"],"host":["{{whitelabel_domain}}"],"query":[{"disabled":true,"description":{"content":"

sample input

\n","type":"text/plain"},"key":"input_data","value":"%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22search_criteria%22%3A%5B%7B%22field%22%3A%22pipelineaudit.pipeline.id%22%2C%22value%22%3A%2255317000000022201%22%2C%22condition%22%3A%22eq%22%7D%5D%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%7D%7D\n"}],"variable":[{"id":"d7ff5994-c19b-4087-a89e-96221a4f57a6","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portalname}}"}]}},"response":[{"id":"b32b429b-0129-4986-9026-2800454dcd6b","name":"All jobs in a pipeline","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dataprep.sample.com/api/v1/portals/samplewl/jobs_list?input_data=%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22search_criteria%22%3A%5B%7B%22field%22%3A%22pipelineaudit.pipeline.id%22%2C%22value%22%3A%2255317000000022201%22%2C%22condition%22%3A%22eq%22%7D%5D%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%7D%7D\n","protocol":"https","host":["dataprep","sample","com"],"path":["api","v1","portals","samplewl","jobs_list"],"query":[{"key":"input_data","value":"%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22search_criteria%22%3A%5B%7B%22field%22%3A%22pipelineaudit.pipeline.id%22%2C%22value%22%3A%2255317000000022201%22%2C%22condition%22%3A%22eq%22%7D%5D%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%7D%7D\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"ZGS"},{"key":"Date","value":"Thu, 20 Nov 2025 11:53:22 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private,no-cache,no-store,max-age=0,must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Access-Control-Allow-Origin","value":"https://*.zoho.com"},{"key":"Expect-CT","value":"max-age=30, enforce"},{"key":"Set-Cookie","value":"Secure;HttpOnly;SameSite=Lax"},{"key":"vary","value":"accept-encoding"},{"key":"Strict-Transport-Security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"Follow the below steps to find the pipelinerun_id from the sample response:\n1. Navigate to the \"pipelineruns\" object.\n2. Identify the \"id\" key right below the object. The corresponding value is the pipelinerun_id.\n\n\n{\n \"pipelineruns\": [\n {\n \"id\": \"55317000000022727\",\n \"pipelineaudit\": {\n \"id\": \"55317000000022205\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763464694293\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381847660\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763464694298\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n }\n },\n \"status\": 1\n },\n \"pipelinerunconfigaudit\": {\n \"id\": \"55317000000022725\",\n \"status\": 1,\n \"skip_export_invalid_data\": false,\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"pipelinefile\": {\n \"id\": \"55317000000022719\"\n }\n },\n \"execution_status\": 1,\n \"type\": 5,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763464683311\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modified_time\": \"1763464694258\",\n \"completion_time\": \"1763464694256\",\n \"data_interval_start_time\": \"1763381848767\",\n \"data_interval_end_time\": \"1763464683251\",\n \"rerun_count\": 0,\n \"profile_output\": false,\n \"skip_export_invalid_data\": false,\n \"status\": 1,\n \"pipelinerunaudit\": {\n \"id\": \"55317000000022729\",\n \"created_time\": \"1763464683318\",\n \"modtime\": \"1763464694289\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\",\n \"pipelineaudit\": {\n \"id\": \"55317000000022205\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"status\": 1\n },\n \"pipelinerunconfigaudit\": {\n \"id\": \"55317000000022725\",\n \"status\": 1,\n \"skip_export_invalid_data\": false,\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"pipelinefile\": {\n \"id\": \"55317000000022719\"\n }\n },\n \"execution_status\": 1,\n \"type\": 5,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763464683311\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohocorp.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"1010140****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modified_time\": \"1763464694258\",\n \"completion_time\": \"1763464694256\",\n \"data_interval_start_time\": \"1763381848767\",\n \"data_interval_end_time\": \"1763464683251\",\n \"rerun_count\": 0,\n \"profile_output\": false,\n \"skip_export_invalid_data\": false,\n \"status\": 1\n },\n \"status\": 1,\n \"execution_policy\": 1,\n \"execution_status\": 1,\n \"completion_time\": \"1763464694271\",\n \"storage_used\": \"213400\",\n \"row_count\": \"762\"\n ///////////////\n },\n }\n ],\n \"list_info\": {\n \"start_index\": 1,\n \"sort_field\": \"created_time\",\n \"sort_order\": \"desc\",\n \"start_count\": 1,\n \"has_more_rows\": false,\n \"row_count\": 1\n },\n \"response_status\": [\n {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n ]\n}\n"}],"_postman_id":"5a9d435e-a938-402f-b442-17690d601c7e"},{"name":"Job status","id":"6f6b45a2-3d2f-4e41-bc11-72516d0253a6","protocolProfileBehavior":{"disabledSystemHeaders":{"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portalname}}/pipelineruns/:{{pipelinerun_id}}/job_info","description":"

This API lists the status of a pipeline run, task instances, and their mappings.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample response

You can view the status of a job with the granular details in the Job summary response.

Click here to view the detailed response structure of the Job Summary API, including field-level descriptions and JSON examples, to help you interpret each component of the response with clarity.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portalname}}"},{"id":"1787fe2e-4827-41bc-b06a-09a453883492","description":{"content":"

Provide the ID of a job in a pipeline. You can get it using the Get all jobs in a pipeline or run pipeline API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipelinerun_id}}"}]}},"response":[{"id":"9a1df521-4578-4d26-b2ec-967d75777300","name":"Job status","originalRequest":{"method":"GET","header":[],"url":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelineruns/55317000000022727/job_info"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"ZGS"},{"key":"Date","value":"Thu, 20 Nov 2025 11:56:05 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"private,no-cache,no-store,max-age=0,must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Access-Control-Allow-Origin","value":"https://*.zoho.com"},{"key":"Expect-CT","value":"max-age=30, enforce"},{"key":"Set-Cookie","value":"Secure;HttpOnly;SameSite=Lax"},{"key":"vary","value":"accept-encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=64072000; includeSubDomains; preload"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"pipelinerun\": {\n \"id\": \"55317000000022727\",\n \"pipelineaudit\": {\n \"id\": \"55317000000022205\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"status\": 1\n },\n \"pipelinerunconfigaudit\": {\n \"id\": \"55317000000022725\",\n \"status\": 1,\n \"skip_export_invalid_data\": false,\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"pipelinefile\": {\n \"id\": \"55317000000022719\"\n }\n },\n \"execution_status\": 1,\n \"type\": 5,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763464683311\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modified_time\": \"1763464694258\",\n \"completion_time\": \"1763464694256\",\n \"data_interval_start_time\": \"1763381848767\",\n \"data_interval_end_time\": \"1763464683251\",\n \"rerun_count\": 0,\n \"profile_output\": false,\n \"skip_export_invalid_data\": false,\n \"status\": 1,\n \"pipelinetaskinstancemappers\": {\n \"55317000000022747\": [\n \"55317000000022743\"\n ],\n \"55317000000022735\": [\n \"55317000000022731\"\n ],\n \"55317000000022763\": [\n \"55317000000022759\"\n ],\n \"55317000000022751\": [\n \"55317000000022747\"\n ],\n \"55317000000022755\": [\n \"55317000000022739\",\n \"55317000000022751\"\n ],\n \"55317000000022743\": [],\n \"55317000000022739\": [\n \"55317000000022735\"\n ],\n \"55317000000022759\": [\n \"55317000000022755\"\n ],\n \"55317000000022731\": []\n },\n \"pipelinetaskinstances\": [\n {\n \"id\": \"55317000000022747\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022395\",\n \"name\": \"Sample dataset\",\n \"type\": 7,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763381966815\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763381966815\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": 1,\n \"index\": 0,\n \"created_time\": \"1763464683520\",\n \"start_time\": \"1763464685875\",\n \"completion_time\": \"1763464687377\",\n \"client_meta\": \"{\\\"top\\\":235,\\\"left\\\":80,\\\"version\\\":1}\",\n \"message\": null,\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchParseRawDataOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"20965\",\n \"row_count\": \"254\",\n \"status\": 1,\n \"time_to_live\": \"1763468285875\",\n \"rawdatasetaudit\": {\n \"id\": \"55317000000031015\",\n \"audit_time\": \"1763464685788\",\n \"is_referred\": false,\n \"datasourceaudit\": {\n \"id\": \"55317000000032001\"\n },\n \"rawdatasetconfigaudit\": {\n \"id\": \"55317000000022335\"\n },\n \"rawdataset\": {\n \"id\": \"55317000000022323\",\n \"name\": \"Sample dataset\",\n \"replication_frequency\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381961730\",\n \"modtime\": null,\n \"status\": 1,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022321\",\n \"name\": \"11393110029878638\",\n \"replication_type\": \"1\",\n \"status\": 1,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"connection\": {\n \"id\": \"55317000000022319\"\n }\n }\n },\n \"status\": 1,\n \"error_message\": null\n }\n },\n {\n \"id\": \"55317000000022763\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022701\",\n \"name\": \"result\",\n \"type\": 20,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763382042996\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763382042996\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": 1,\n \"index\": 0,\n \"created_time\": \"1763464683567\",\n \"start_time\": \"1763464693689\",\n \"completion_time\": \"1763464693819\",\n \"client_meta\": \"{\\\"top\\\":135,\\\"left\\\":815,\\\"version\\\":1}\",\n \"message\": null,\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchLoadOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"41727\",\n \"row_count\": \"280\",\n \"status\": 1,\n \"time_to_live\": \"1763468293689\",\n \"datasetexportaudit\": {\n \"id\": \"55317000000025069\",\n \"dsauditstatefile\": {\n \"id\": \"55317000000025073\"\n },\n \"datasinkaudit\": {\n \"id\": \"55317000000025067\"\n },\n \"datasetexport\": {\n \"id\": \"55317000000022699\",\n \"dataset\": {\n \"id\": \"55317000000022653\",\n \"name\": \"Sample_items_1_Sample dataset_1\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": false,\n \"is_pii_marked\": false,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"selected_sample\": {\n \"id\": \"55317000000022665\"\n }\n },\n \"datasink\": {\n \"id\": \"55317000000022697\",\n \"status\": 1,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"connection\": {\n \"id\": \"55317000000022207\",\n \"name\": \"file_samplewl1763381884048\",\n \"connection_json\": \"{\\\"portalName\\\":\\\"samplewl\\\",\\\"is_authorised\\\":false}\",\n \"type\": \"1\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"owner\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381884054\",\n \"modified_by\": null,\n \"modtime\": null,\n \"status\": 1,\n \"category\": \"2\",\n \"base_type\": null,\n \"sub_type\": null\n }\n },\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763382042966\",\n \"modified_by\": null,\n \"modtime\": \"1763382042966\",\n \"status\": 1,\n \"datasetexportaudit\": {\n \"id\": \"55317000000036011\",\n \"dsauditstatefile\": {\n \"id\": \"55317000000036015\",\n \"datasetstate\": {\n \"id\": \"55317000000041009\"\n },\n \"type\": 0,\n \"is_error\": false,\n \"error_message\": null\n },\n \"datasinkaudit\": {\n \"id\": \"55317000000036009\",\n \"created_time\": \"1763639401788\",\n \"completed_time\": \"1763639401942\",\n \"status\": 1,\n \"execution_status\": 1,\n \"type\": 0,\n \"datasink\": {\n \"id\": \"55317000000022697\"\n }\n },\n \"datasetexport\": {\n \"id\": \"55317000000022699\",\n \"dataset\": {\n \"id\": \"55317000000022653\"\n },\n \"datasink\": {\n \"id\": \"55317000000022697\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"status\": 1\n },\n \"datasetexportconfigaudit\": {\n \"id\": \"55317000000022715\",\n \"status\": 1,\n \"datasetexport\": {\n \"id\": \"55317000000022699\"\n },\n \"datasetexportfile\": {\n \"id\": \"55317000000022711\"\n }\n },\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763639401819\",\n \"error_message\": null,\n \"info\": \"{\\\"currentRetry\\\":0}\",\n \"execution_status\": 1,\n \"progress\": 100,\n \"status\": 1,\n \"type\": 1,\n \"dptask\": null\n }\n },\n \"datasetexportconfigaudit\": {\n \"id\": \"55317000000022715\"\n },\n \"created_time\": \"1763464693654\",\n \"error_message\": null,\n \"info\": \"{\\\"currentRetry\\\":0}\",\n \"execution_status\": 1,\n \"progress\": 100,\n \"status\": 1,\n \"type\": 1,\n \"datasetexportauditmetric\": {\n \"id\": \"55317000000025083\",\n \"row_count\": \"280\",\n \"col_count\": \"18\",\n \"size\": \"41727\",\n \"status\": 1,\n \"datasetexportaudit\": {\n \"id\": \"55317000000025069\",\n \"dsauditstatefile\": {\n \"id\": \"55317000000025073\"\n },\n \"datasinkaudit\": {\n \"id\": \"55317000000025067\"\n },\n \"datasetexport\": {\n \"id\": \"55317000000022699\"\n },\n \"datasetexportconfigaudit\": {\n \"id\": \"55317000000022715\"\n },\n \"created_time\": \"1763464693654\",\n \"error_message\": null,\n \"info\": \"{\\\"currentRetry\\\":0}\",\n \"execution_status\": 1,\n \"progress\": 100,\n \"status\": 1,\n \"type\": 1\n },\n \"quality\": \"{\\\"valid\\\":4844,\\\"invalid\\\":164,\\\"missing\\\":32}\"\n }\n }\n },\n {\n \"id\": \"55317000000022731\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022293\",\n \"name\": \"11393032752380635\",\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763381887922\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763381887922\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": -3,\n \"index\": 0,\n \"created_time\": \"1763464683449\",\n \"start_time\": null,\n \"completion_time\": null,\n \"client_meta\": \"{\\\"top\\\":30,\\\"left\\\":80,\\\"version\\\":1}\",\n \"message\": null,\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchExtractOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"0\",\n \"row_count\": \"0\",\n \"status\": 6,\n \"time_to_live\": null,\n \"datasourceaudit\": {\n \"pipelinedatasource\": {\n \"id\": \"55317000000022213\",\n \"name\": \"11393032752380635\",\n \"replication_type\": \"1\",\n \"replication_history\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381884445\",\n \"modified_by\": null,\n \"modtime\": null,\n \"status\": 1,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n },\n \"connection\": {\n \"id\": \"55317000000022207\",\n \"name\": \"file_samplewl1763381884048\",\n \"type\": \"1\",\n \"owner\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"status\": 1,\n \"category\": \"2\",\n \"base_type\": null,\n \"sub_type\": null,\n \"connection_json\": \"{\\\"portalName\\\":\\\"samplewl\\\",\\\"is_authorised\\\":false}\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381884054\",\n \"modified_by\": null,\n \"modtime\": null\n },\n \"datasourceaudit\": {\n \"id\": \"55317000000022221\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381884505\",\n \"execution_status\": 1,\n \"streams_info\": \"{\\\"55317000000022215\\\":{\\\"size\\\":46289,\\\"catalog_stream_id\\\":\\\"0\\\",\\\"execution_status\\\":\\\"SUCCESS\\\",\\\"progress\\\":100}}\",\n \"killed_batch_catalog_ids\": null,\n \"completed_time\": \"1763381884603\",\n \"status\": 1,\n \"type\": 0,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022213\",\n \"name\": \"11393032752380635\",\n \"replication_type\": \"1\",\n \"status\": 1,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"connection\": {\n \"id\": \"55317000000022207\"\n }\n },\n \"error_message\": null,\n \"dptask\": null\n }\n }\n }\n },\n {\n \"id\": \"55317000000022735\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022303\",\n \"name\": \"Sample_items.csv\",\n \"type\": 7,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763381887968\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763381887968\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": -3,\n \"index\": 0,\n \"created_time\": \"1763464683477\",\n \"start_time\": null,\n \"completion_time\": null,\n \"client_meta\": \"{\\\"top\\\":30,\\\"left\\\":80,\\\"version\\\":1}\",\n \"message\": null,\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchParseRawDataOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"0\",\n \"row_count\": \"0\",\n \"status\": 6,\n \"time_to_live\": null,\n \"rawdatasetaudit\": {\n \"rawdataset\": {\n \"id\": \"55317000000022215\",\n \"name\": \"Sample_items.csv\",\n \"status\": 1,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022213\"\n }\n }\n }\n },\n {\n \"id\": \"55317000000022751\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022403\",\n \"name\": \"Sample dataset\",\n \"type\": 10,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763381966844\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763381966844\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": 1,\n \"index\": 0,\n \"created_time\": \"1763464683531\",\n \"start_time\": \"1763464688128\",\n \"completion_time\": \"1763464689036\",\n \"client_meta\": \"{\\\"top\\\":240,\\\"left\\\":312,\\\"version\\\":1}\",\n \"message\": \"null\",\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchTransformOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"20965\",\n \"row_count\": \"254\",\n \"status\": 1,\n \"time_to_live\": \"1763468288128\",\n \"datasetaudit\": {\n \"id\": \"55317000000033001\",\n \"created_time\": \"1763464688053\",\n \"created_by\": {\n \"id\": \"55317000000016003\",\n \"zuid\": \"10104987017\",\n \"username\": \"Sreekrishna\",\n \"email_id\": \"sreekrishna.s+wl@zohotest.com\",\n \"invited_time\": \"1757506175059\",\n \"profile\": {\n \"id\": \"3925\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10104987017&fs=thumb\"\n },\n \"audit_time\": \"1763464688053\",\n \"completion_time\": \"1763464688997\",\n \"execution_status\": 1,\n \"description\": null,\n \"dataset\": {\n \"id\": \"55317000000022355\",\n \"name\": \"Sample dataset_1\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": false,\n \"is_pii_marked\": false,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"selected_sample\": {\n \"id\": \"55317000000022367\"\n }\n },\n \"exportcatalogaudit\": null,\n \"rulesetaudit\": {\n \"id\": \"55317000000022359\",\n \"audit_time\": \"1763381964436\",\n \"is_committed\": 1,\n \"ruleset\": {\n \"id\": \"55317000000022357\"\n },\n \"status\": 1,\n \"rules_count\": 0\n },\n \"modtime\": \"1763464689000\",\n \"status\": 1,\n \"type\": 0,\n \"error_message\": null,\n \"datasetstate\": {\n \"id\": \"55317000000033009\",\n \"datasetaudit\": {\n \"id\": \"55317000000033001\"\n },\n \"execution_status\": 1,\n \"is_error\": false,\n \"error_message\": null\n },\n \"rules_count\": 0\n }\n },\n {\n \"id\": \"55317000000022755\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022595\",\n \"name\": \"11393172955454265\",\n \"type\": 15,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763382024963\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763382024963\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": 1,\n \"index\": 0,\n \"created_time\": \"1763464683542\",\n \"start_time\": \"1763464689918\",\n \"completion_time\": \"1763464691581\",\n \"client_meta\": null,\n \"message\": null,\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchTransformOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"41727\",\n \"row_count\": \"508\",\n \"status\": 1,\n \"time_to_live\": \"1763468289918\",\n \"rawdatasetaudit\": {\n \"id\": \"55317000000031043\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763464690026\",\n \"audit_time\": \"1763464690026\",\n \"is_referred\": false,\n \"datasourceaudit\": {\n \"id\": \"55317000000031039\",\n \"execution_status\": 1,\n \"streams_info\": \"{\\\"55317000000022561\\\":{\\\"rule\\\":55317000000022567}}\",\n \"killed_batch_catalog_ids\": null,\n \"completed_time\": null,\n \"status\": 1,\n \"type\": 0,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022559\"\n },\n \"error_message\": null\n },\n \"rawdatasetconfigaudit\": {\n \"id\": \"55317000000022565\",\n \"status\": 1,\n \"rawdataset\": {\n \"id\": \"55317000000022561\"\n },\n \"catalog_file\": {\n \"id\": \"55317000000022563\"\n }\n },\n \"rawdataset\": {\n \"id\": \"55317000000022561\",\n \"name\": \"Sample_items_1_Sample dataset_1\",\n \"status\": 1,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022559\"\n }\n },\n \"status\": 1,\n \"error_message\": null\n },\n \"datasourceaudit\": {\n \"id\": \"55317000000031039\",\n \"execution_status\": 1,\n \"streams_info\": \"{\\\"55317000000022561\\\":{\\\"rule\\\":55317000000022567}}\",\n \"killed_batch_catalog_ids\": null,\n \"completed_time\": null,\n \"status\": 1,\n \"type\": 0,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022559\",\n \"name\": \"11393172955454265\",\n \"replication_type\": \"1\",\n \"replication_history\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763382024648\",\n \"modified_by\": null,\n \"modtime\": null,\n \"status\": 1,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n },\n \"connection\": {\n \"id\": \"55317000000022411\",\n \"name\": \"sl_derive\",\n \"type\": \"7\",\n \"owner\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"status\": 1,\n \"category\": \"2\",\n \"base_type\": null,\n \"sub_type\": null,\n \"connection_json\": \"{\\\"type\\\":\\\"sl_derive\\\",\\\"is_authorised\\\":false}\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381990312\",\n \"modified_by\": null,\n \"modtime\": null\n },\n \"rule\": {\n \"id\": \"55317000000022567\",\n \"rule_json\": \"{\\\"name\\\":\\\"join\\\",\\\"params\\\":{\\\"type\\\":\\\"inner\\\",\\\"keys\\\":[{\\\"cols\\\":[\\\"DS.Item ID\\\",\\\"DS1.Item ID\\\"],\\\"iCase\\\":false,\\\"iSpace\\\":false}],\\\"colList\\\":[{\\\"as\\\":\\\"Item ID\\\",\\\"cols\\\":[\\\"DS.Item ID\\\"]},{\\\"as\\\":\\\"Name\\\",\\\"cols\\\":[\\\"DS.Name\\\"]},{\\\"as\\\":\\\"Brand\\\",\\\"cols\\\":[\\\"DS.Brand\\\"]},{\\\"as\\\":\\\"SKU\\\",\\\"cols\\\":[\\\"DS.SKU\\\"]},{\\\"as\\\":\\\"Price\\\",\\\"cols\\\":[\\\"DS.Price\\\"]},{\\\"as\\\":\\\"Country of Origin\\\",\\\"cols\\\":[\\\"DS.Country of Origin\\\"]},{\\\"as\\\":\\\"Item Status\\\",\\\"cols\\\":[\\\"DS.Item Status\\\"]},{\\\"as\\\":\\\"Created At\\\",\\\"cols\\\":[\\\"DS.Created At\\\"]},{\\\"as\\\":\\\"Updated At\\\",\\\"cols\\\":[\\\"DS.Updated At\\\"]},{\\\"as\\\":\\\"Item ID1\\\",\\\"cols\\\":[\\\"DS1.Item ID\\\"]},{\\\"as\\\":\\\"Name1\\\",\\\"cols\\\":[\\\"DS1.Name\\\"]},{\\\"as\\\":\\\"1Brand\\\",\\\"cols\\\":[\\\"DS1.Brand\\\"]},{\\\"as\\\":\\\"SKU1\\\",\\\"cols\\\":[\\\"DS1.SKU\\\"]},{\\\"as\\\":\\\"Price1\\\",\\\"cols\\\":[\\\"DS1.Price\\\"]},{\\\"as\\\":\\\"Country of Origin1\\\",\\\"cols\\\":[\\\"DS1.Country of Origin\\\"]},{\\\"as\\\":\\\"Item Status1\\\",\\\"cols\\\":[\\\"DS1.Item Status\\\"]},{\\\"as\\\":\\\"Created At1\\\",\\\"cols\\\":[\\\"DS1.Created At\\\"]},{\\\"as\\\":\\\"Updated At1\\\",\\\"cols\\\":[\\\"DS1.Updated At\\\"]}],\\\"withDS\\\":[{\\\"dsInfo\\\":{\\\"dsID\\\":\\\"55317000000022355\\\",\\\"alias\\\":\\\"DS1\\\"}}]},\\\"meta\\\":\\\"{\\\\\\\"keys\\\\\\\":[{\\\\\\\"ds1\\\\\\\":\\\\\\\"Item ID\\\\\\\",\\\\\\\"ds2\\\\\\\":\\\\\\\"Item ID\\\\\\\",\\\\\\\"iCase\\\\\\\":false,\\\\\\\"iSpace\\\\\\\":false}],\\\\\\\"transformOrigin\\\\\\\":1}\\\"}\",\n \"type\": \"TRANSFORM_RULE\",\n \"description\": null,\n \"created_time\": \"1763382024686\",\n \"created_by\": {\n \"id\": \"55317000000022189\"\n }\n },\n \"rawdatasetaudit\": {\n \"id\": \"55317000000035013\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763639396519\",\n \"audit_time\": \"1763639396519\",\n \"is_referred\": false,\n \"datasourceaudit\": {\n \"id\": \"55317000000035009\",\n \"execution_status\": 1,\n \"streams_info\": \"{\\\"55317000000022561\\\":{\\\"rule\\\":55317000000022567}}\",\n \"killed_batch_catalog_ids\": null,\n \"completed_time\": null,\n \"status\": 1,\n \"type\": 0,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022559\"\n },\n \"error_message\": null\n },\n \"rawdatasetconfigaudit\": {\n \"id\": \"55317000000022565\",\n \"status\": 1,\n \"rawdataset\": {\n \"id\": \"55317000000022561\"\n },\n \"catalog_file\": {\n \"id\": \"55317000000022563\"\n }\n },\n \"rawdataset\": {\n \"id\": \"55317000000022561\",\n \"name\": \"Sample_items_1_Sample dataset_1\",\n \"status\": 1,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022559\"\n }\n },\n \"status\": 1,\n \"error_message\": null\n },\n \"parent_dataset\": [\n {\n \"id\": \"55317000000022251\",\n \"name\": \"Sample_items_1\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381885510\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763381888044\",\n \"status\": 1,\n \"is_locked\": false,\n \"is_ready\": false,\n \"is_pii_marked\": false,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n },\n \"selected_sample\": {\n \"id\": \"55317000000022263\",\n \"dataset\": {\n \"id\": \"55317000000022251\"\n },\n \"current_rule\": {\n \"id\": \"55317000000022257\"\n },\n \"modtime\": \"1763381941460\",\n \"is_error\": false,\n \"error_message\": null,\n \"execution_status\": 1,\n \"samplestate\": {\n \"id\": \"55317000000022267\"\n },\n \"status\": 1\n },\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763639402962\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false\n },\n \"datasource_type\": 1,\n \"is_shared_to_support\": false,\n \"is_parent\": true\n },\n {\n \"id\": \"55317000000022355\",\n \"name\": \"Sample dataset_1\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381964425\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763381966870\",\n \"status\": 1,\n \"is_locked\": false,\n \"is_ready\": false,\n \"is_pii_marked\": false,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n },\n \"selected_sample\": {\n \"id\": \"55317000000022367\",\n \"dataset\": {\n \"id\": \"55317000000022355\"\n },\n \"current_rule\": {\n \"id\": \"55317000000022361\"\n },\n \"modtime\": \"1763381972723\",\n \"is_error\": false,\n \"error_message\": null,\n \"execution_status\": 1,\n \"samplestate\": {\n \"id\": \"55317000000022371\"\n },\n \"status\": 1\n },\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763639402962\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false\n },\n \"datasource_type\": 2,\n \"is_shared_to_support\": false,\n \"is_parent\": false\n }\n ]\n },\n \"error_message\": null,\n \"logs\": []\n }\n },\n {\n \"id\": \"55317000000022739\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022311\",\n \"name\": \"Sample_items\",\n \"type\": 10,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763381888014\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763381888014\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": 1,\n \"index\": 0,\n \"created_time\": \"1763464683491\",\n \"start_time\": \"1763464686107\",\n \"completion_time\": \"1763464686107\",\n \"client_meta\": \"{\\\"top\\\":35,\\\"left\\\":312,\\\"version\\\":1}\",\n \"message\": null,\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchTransformOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"20956\",\n \"row_count\": \"254\",\n \"status\": 2,\n \"time_to_live\": \"1763468283491\",\n \"datasetaudit\": {\n \"id\": \"55317000000022437\",\n \"created_time\": \"1763381990611\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"audit_time\": \"1763381990610\",\n \"completion_time\": \"1763381991743\",\n \"execution_status\": 1,\n \"description\": null,\n \"dataset\": {\n \"id\": \"55317000000022251\",\n \"name\": \"Sample_items_1\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": false,\n \"is_pii_marked\": false,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"selected_sample\": {\n \"id\": \"55317000000022263\"\n }\n },\n \"exportcatalogaudit\": null,\n \"rulesetaudit\": {\n \"id\": \"55317000000022255\",\n \"audit_time\": \"1763381885525\",\n \"is_committed\": 1,\n \"ruleset\": {\n \"id\": \"55317000000022253\"\n },\n \"status\": 1,\n \"rules_count\": 0\n },\n \"modtime\": \"1763381991745\",\n \"status\": 1,\n \"type\": 0,\n \"error_message\": null,\n \"datasetstate\": {\n \"id\": \"55317000000022441\",\n \"datasetaudit\": {\n \"id\": \"55317000000022437\"\n },\n \"execution_status\": 1,\n \"is_error\": false,\n \"error_message\": null\n },\n \"rules_count\": 0\n }\n },\n {\n \"id\": \"55317000000022743\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022385\",\n \"name\": \"11393110029878638\",\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763381966776\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763381966776\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": 1,\n \"index\": 0,\n \"created_time\": \"1763464683500\",\n \"start_time\": \"1763464684471\",\n \"completion_time\": \"1763464684858\",\n \"client_meta\": \"{\\\"top\\\":235,\\\"left\\\":80,\\\"version\\\":1}\",\n \"message\": null,\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchExtractOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"46289\",\n \"row_count\": \"0\",\n \"status\": 1,\n \"time_to_live\": \"1763468284471\",\n \"datasourceaudit\": {\n \"id\": \"55317000000032001\",\n \"execution_status\": 1,\n \"streams_info\": \"{\\\"55317000000022323\\\":{\\\"size\\\":-1,\\\"catalog_stream_id\\\":\\\"55317000000022323\\\",\\\"execution_status\\\":\\\"SUCCESS\\\",\\\"progress\\\":100}}\",\n \"killed_batch_catalog_ids\": null,\n \"completed_time\": \"1763464684803\",\n \"status\": 1,\n \"type\": 1,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022321\",\n \"name\": \"11393110029878638\",\n \"replication_type\": \"1\",\n \"replication_history\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381961722\",\n \"modified_by\": null,\n \"modtime\": null,\n \"status\": 1,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n },\n \"connection\": {\n \"id\": \"55317000000022319\",\n \"name\": \"REST API connection__1763381961129\",\n \"type\": \"2\",\n \"status\": 1,\n \"category\": null,\n \"base_type\": \"No_Auth\",\n \"sub_type\": null,\n \"connection_json\": \"{\\\"url\\\":\\\"https://dataprep.finepick.com/v1/mock/Items.csv\\\",\\\"httpmethod\\\":\\\"GET\\\",\\\"is_authorised\\\":false}\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"owner\": null,\n \"created_time\": \"1763381961352\",\n \"modified_by\": null,\n \"modtime\": null\n },\n \"datasourceaudit\": {\n \"id\": \"55317000000035001\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763639391282\",\n \"execution_status\": 1,\n \"streams_info\": \"{\\\"55317000000022323\\\":{\\\"size\\\":-1,\\\"catalog_stream_id\\\":\\\"55317000000022323\\\",\\\"execution_status\\\":\\\"SUCCESS\\\",\\\"progress\\\":100}}\",\n \"killed_batch_catalog_ids\": null,\n \"completed_time\": \"1763639391727\",\n \"status\": 1,\n \"type\": 1,\n \"pipelinedatasource\": {\n \"id\": \"55317000000022321\",\n \"name\": \"11393110029878638\",\n \"replication_type\": \"1\",\n \"status\": 1,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"connection\": {\n \"id\": \"55317000000022319\"\n }\n },\n \"error_message\": null,\n \"dptask\": null\n }\n },\n \"error_message\": null,\n \"logs\": []\n }\n },\n {\n \"id\": \"55317000000022759\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\"\n },\n \"pipelinetask\": {\n \"id\": \"55317000000022679\",\n \"name\": \"Sample_items_1_Sample dataset_1\",\n \"type\": 10,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"created_by\": {\n \"id\": \"55317000000022189\"\n },\n \"created_time\": \"1763382025476\",\n \"modified_by\": {\n \"id\": \"55317000000022189\"\n },\n \"modified_time\": \"1763382025477\",\n \"status\": 1,\n \"latest_only\": false,\n \"depends_on_past\": false,\n \"trigger_rule\": \"ALL_SUCCESS\",\n \"client_meta\": null,\n \"weight\": 1\n },\n \"execution_status\": 1,\n \"index\": 0,\n \"created_time\": \"1763464683555\",\n \"start_time\": \"1763464692322\",\n \"completion_time\": \"1763464693232\",\n \"client_meta\": \"{\\\"left\\\":502,\\\"top\\\":132,\\\"version\\\":1}\",\n \"message\": \"null\",\n \"operator_id\": \"com.zoho.dataprep.operator.ZSOrchTransformOperator\",\n \"retry_count\": 0,\n \"storage_used\": \"41727\",\n \"row_count\": \"0\",\n \"status\": 1,\n \"time_to_live\": \"1763468292322\",\n \"datasetaudit\": {\n \"id\": \"55317000000025047\",\n \"created_time\": \"1763464692265\",\n \"created_by\": {\n \"id\": \"55317000000016003\",\n \"zuid\": \"10104987017\",\n \"username\": \"Sreekrishna\",\n \"email_id\": \"sreekrishna.s+wl@zohotest.com\",\n \"invited_time\": \"1757506175059\",\n \"profile\": {\n \"id\": \"3925\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10104987017&fs=thumb\"\n },\n \"audit_time\": \"1763464692264\",\n \"completion_time\": \"1763464693156\",\n \"execution_status\": 1,\n \"description\": null,\n \"dataset\": {\n \"id\": \"55317000000022653\",\n \"name\": \"Sample_items_1_Sample dataset_1\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": false,\n \"is_pii_marked\": false,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n \"selected_sample\": {\n \"id\": \"55317000000022665\"\n }\n },\n \"exportcatalogaudit\": null,\n \"rulesetaudit\": {\n \"id\": \"55317000000022657\",\n \"audit_time\": \"1763382025365\",\n \"is_committed\": 1,\n \"ruleset\": {\n \"id\": \"55317000000022655\"\n },\n \"status\": 1,\n \"rules_count\": 0\n },\n \"modtime\": \"1763464693166\",\n \"status\": 1,\n \"type\": 0,\n \"error_message\": null,\n \"datasetstate\": {\n \"id\": \"55317000000025055\",\n \"datasetaudit\": {\n \"id\": \"55317000000025047\"\n },\n \"execution_status\": 1,\n \"is_error\": false,\n \"error_message\": null\n },\n \"rules_count\": 0\n }\n }\n ],\n \"storage_used\": 213400,\n \"row_count\": 762,\n \"pipelinerunaudit\": {\n \"id\": \"55317000000022729\",\n \"created_time\": \"1763464683318\",\n \"modtime\": \"1763464694289\",\n \"pipelinerun\": {\n \"id\": \"55317000000022727\",\n \"pipelineaudit\": {\n \"id\": \"55317000000022205\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"status\": 1\n },\n \"pipelinerunconfigaudit\": {\n \"id\": \"55317000000022725\",\n \"status\": 1,\n \"skip_export_invalid_data\": false,\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000022201\"\n },\n \"pipelinefile\": {\n \"id\": \"55317000000022719\"\n }\n },\n \"execution_status\": 1,\n \"type\": 5,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763464683311\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modified_time\": \"1763464694258\",\n \"completion_time\": \"1763464694256\",\n \"data_interval_start_time\": \"1763381848767\",\n \"data_interval_end_time\": \"1763464683251\",\n \"rerun_count\": 0,\n \"profile_output\": false,\n \"skip_export_invalid_data\": false,\n \"status\": 1\n },\n \"status\": 1,\n \"execution_policy\": 1,\n \"execution_status\": 1,\n \"completion_time\": \"1763464694271\",\n \"storage_used\": \"213400\",\n \"row_count\": \"762\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763639402962\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381847660\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763639402966\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n }\n }\n },\n \"pipeline\": {\n \"id\": \"55317000000022201\",\n \"name\": \"White Label pipeline\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381848767\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763639402962\",\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false,\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"created_time\": \"1763381847660\",\n \"modified_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110****\",\n \"username\": \"zylker2\",\n \"email_id\": \"zylker2@zohotest.com\",\n \"invited_time\": \"1763381405317\",\n \"profile\": {\n \"id\": \"3928\"\n },\n \"status\": 1,\n \"zsoid\": \"10101****\",\n \"profilelink\": \"https://profile.zoho.com/file?ID=10110****&fs=thumb\"\n },\n \"modtime\": \"1763639402966\",\n \"status\": 1,\n \"migration_status\": 3,\n \"is_locked\": false\n }\n }\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n ]\n }\n}\n"}],"_postman_id":"6f6b45a2-3d2f-4e41-bc11-72516d0253a6"},{"name":"Create workspace","id":"725deba7-c344-4290-b73a-99b7bf49ed05","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project\":{\"name\":\"My Workspace-8\",\"migration_status\":3}}","description":"

sample input

\n","type":"text","uuid":"7a50a25a-7526-489f-a951-8bf6329325fe"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/workspace","description":"

This API creates a new workspace in which a user is an Account admin, or an Organization admin, or a shared user.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"project\":{\"name\":\"My Workspace-8\",\"migration_status\":3}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example values	Description	Mandatory
project	object	{\"..\"}	The main object that contains details about a project/workspace.	Yes
name	string	\"My Workspace-8\"	The name of the workspace that will be created.	Yes
migration_status	number	3	Indicates the migration state or progress of the workspace.	Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","workspace"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"8eade691-3f7d-4027-aa9b-17793518cfaa","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"}]}},"response":[{"id":"e68b0bb1-6919-48ea-854d-22d306d8d6eb","name":"create workspace","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project\":{\"name\":\"My Workspace-8\",\"migration_status\":3}}","description":"sample input","type":"text","uuid":"1fa74231-792e-42fd-a337-32f7f82f5e23"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/workspace"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can get the workspace id under the project section from the response.\n{\n \"project\": {\n \"id\": \"55317000000160091\",\n \"name\": \"My Workspace-9\",\n \"description\": null,\n \"created_by\": {\n \"id\": \"55317000000011001\",\n \"zuid\": \"10101627824\",\n \"username\": \"*****\",\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n ]\n }\n},////"}],"_postman_id":"725deba7-c344-4290-b73a-99b7bf49ed05"},{"name":"Create pipeline","id":"9ac0efbd-aa0f-4854-953f-db9cef446f7a","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project_id\":\"55317000000079163\",\"pipeline\":{\"name\":\"My pipeline-1\"}}","description":"

sample input

\n","type":"text","uuid":"9af63985-bc7a-4c58-92f3-6c4e6379b65f"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipeline","description":"

This API creates a new workspace in which a user is an Account admin, or an Organization admin, or a shared user.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"project_id\":\"55317000000079163\",\"pipeline\":{\"name\":\"My pipeline-1\"}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example values	Description	Mandatory
project_id	string	5317000000079163	The name of the workspace where the pipeline will be created.	Yes
pipeline	string	My pipeline-1	The name of the pipeline that will be created.	Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","pipeline"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"74e50eb2-11ce-4b23-87ac-127c92d5b099","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"}]}},"response":[{"id":"ff17dc66-7da3-4414-8792-6570e8f81b02","name":"Create pipeline","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project_id\":\"55317000000079163\",\"pipeline\":{\"name\":\"My pipeline-1\"}}","description":"sample input","type":"text","uuid":"63d4baba-b9e5-4c43-9400-ddabcbc05e87"}]},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/pipeline"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the pipeline id under the pipeline section.\n{\n \"pipeline\": {\n \"id\": \"55317000000079271\",\n \"name\": \"My pipeline-1\",\n \"description\": null,\n }\n},/////"}],"_postman_id":"9ac0efbd-aa0f-4854-953f-db9cef446f7a"},{"name":"Add file as destination","id":"ba07358b-345e-4d9b-9465-3236854d25f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"catalog\":{\"EXPORTTYPE\":\"FILE\",\"FILEFORMAT\":\"CSV\",\"COMPRESSED\":false,\"OUTFILE\":\"SampleFTP-1\",\"ROW_SEPARATOR\":\"UNIX\",\"QUALIFIER\":\"double\",\"CHARSET\":\"UTF-8\",\"DELIMITER\":\",\",\"INCLUDED_PII_COLS\":[],\"INCLUDE_TYPE\":\"all\"},\"name\":\"SampleFTP-1\",\"export_now\":false}","description":"

sample input

\n","type":"text","uuid":"6361f865-a4c0-4503-82b6-648d7e529599"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasets/:{{dataset_id}}/local_export","description":"

This API is used to add file as the destination in a pipeline.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:
{\"catalog\":{\"EXPORTTYPE\":\"FILE\",\"FILEFORMAT\":\"CSV\",\"COMPRESSED\":false,\"OUTFILE\":\"SampleFTP-1\",\"ROW_SEPARATOR\":\"UNIX\",\"QUALIFIER\":\"double\",\"CHARSET\":\"UTF-8\",\"DELIMITER\":\",\",\"INCLUDED_PII_COLS\":[],\"INCLUDE_TYPE\":\"all\"},\"name\":\"SampleFTP-1\",\"export_now\":false}

Key	Type	Variables / Example Values	Description	Mandatory
catalog	object	`{ \"...\" }`	Contains all settings related to how the file will be exported	Yes
catalog.EXPORTTYPE	string	`FILE`	Specifies the export type. Here, the output will be a file	Yes
catalog.FILEFORMAT	string	`CSV`	Format of the exported file	Yes
catalog.COMPRESSED	boolean	`false`	Indicates whether the exported file should be compressed (for example, zipped)	No
catalog.OUTFILE	string	`SampleFTP-1`	Name of the exported output file	Yes
catalog.ROW_SEPARATOR	string	`UNIX`	Defines line endings for the file (`UNIX` = `\\n`)	No
catalog.QUALIFIER	string	`double`	The quote character used in CSV values (double quotes)	No
catalog.CHARSET	string	`UTF-8`	Character encoding for the exported file	No
catalog.DELIMITER	string	`,`	The delimiter used between CSV fields	No
catalog.INCLUDED_PII_COLS	array	`[]`	List of PII columns to include; empty array means none	No
catalog.INCLUDE_TYPE	string	`all`	Specifies which columns to export (`all` exports all columns)	No
name	string	`SampleFTP-1`	The name of the output file	Yes
export_now	boolean	`false`	If `true`, the export runs immediately; if `false`, only the export task is created	No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","datasets",":{{dataset_id}}","local_export"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"8b5e2176-8abb-4f04-b88e-1a4dcd58a75f","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"43bde0ba-95a0-4973-b9aa-e05157b0c2b8","description":{"content":"

The dataset ID (stage) generated for your import activity. You can retrieve this value from the response of the Import API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{dataset_id}}"}]}},"response":[{"id":"fddff882-b6cd-4d78-ba57-64f5cca8f27b","name":"Add file as destination","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"catalog\":{\"EXPORTTYPE\":\"FILE\",\"FILEFORMAT\":\"CSV\",\"COMPRESSED\":false,\"OUTFILE\":\"SampleFTP-1\",\"ROW_SEPARATOR\":\"UNIX\",\"QUALIFIER\":\"double\",\"CHARSET\":\"UTF-8\",\"DELIMITER\":\",\",\"INCLUDED_PII_COLS\":[],\"INCLUDE_TYPE\":\"all\"},\"name\":\"SampleFTP-1\",\"export_now\":false}","description":"sample input","type":"text","uuid":"7e377c1b-7e87-40d3-aef7-0af04d3254cb"}]},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/datasets/55317000000110039/local_export"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can get the destination id under the datasetexport section\n{\n \"datasetexport\": [\n {\n \"id\": \"55317000000110099\",\n \"dataset\": \n{ \n \"project\": {\n \"id\": \"55317000000092099\"\n },,///////"}],"_postman_id":"ba07358b-345e-4d9b-9465-3236854d25f8"},{"name":"Remove destination","id":"d0cd650a-bbdf-4e87-bce6-c9fd0de675c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"pipelinetask\":\"55317000000110101\"}","description":"

sample input

\n","type":"text","uuid":"7198a237-01e6-46f4-b6d4-1f999d07de84"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/remove_destination","description":"

This API is used to remove an existing destination from a pipeline.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"pipelinetask\":\"55317000000110101\"}
This is the pipeline task ID of the destination task that you want to remove. You can get pipeline info API. Locate the destination task (type = 20); its id is the required pipelineTaskId.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"9245abc9-87c4-4619-9903-942127231419","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"0e9d8b44-b455-424b-b660-0c110f1279d1","name":"Remove destination","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"pipelinetask\":\"55317000000110101\"}","description":"sample input","type":"text","uuid":"06e7a857-dcfb-4ef2-b1c7-fb56231bc989"}]},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelines/55317000000092173/remove_destination"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n },//////"}],"_postman_id":"d0cd650a-bbdf-4e87-bce6-c9fd0de675c7"},{"name":"Save Ruleset Template","id":"bf0af0c3-8493-4a2f-b22b-667bb294468e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"test\",\"description\":\"Sales data rules\",\"includeParseDetails\":true}","description":"

sample input

\n","type":"text","uuid":"e3267a34-1d52-4b7a-acb1-6c59e5fb2614"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/rulesetaudits/:{{rulesetaudit_id}}/save_ruleset_template","description":"

This API is used to save a ruleset as a reusable template for future use.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"name\":\"test\",\"description\":\"Sales data rules\",\"includeParseDetails\":true}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Example Value	Description	Mandatory
`name`	string	`test`	Name of the ruleset or template.	Yes
`description`	string	`Sales data rules`	Description providing details about the ruleset or its purpose.	No
`includeParseDetails`	boolean	`true`	Indicates whether parsing details should be included while saving the ruleset.	No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","rulesetaudits",":{{rulesetaudit_id}}","save_ruleset_template"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"49a2ec69-f923-4ee2-8092-f74ecd170c1a","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"2b122d2a-5e6e-404a-933b-ca734c719f23","description":{"content":"

Provide the Ruleset Audit ID of the stage where you want to save the ruleset as a template. You can get it from the response of the Get Pipelines Info API.\nSteps to get the ruleset audit id:

In the Pipeline info response, locate the Transform task (type = 10) in pipelinetasks.
Navigate through the nested objects: dataset → selected_sample → current_rule.
Use the value of current_rule.pointer as the Ruleset Audit ID.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{rulesetaudit_id}}"}]}},"response":[{"id":"ab8ca8e7-998f-41d1-8e86-9ef9f2c296b7","name":"Save Ruleset Template","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"test\",\"description\":\"Sales data rules\",\"includeParseDetails\":true}","description":"sample input","type":"text","uuid":"06e7a857-dcfb-4ef2-b1c7-fb56231bc989"}]},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/rulesetaudits/55317000000155145/save_ruleset_template"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n },//////"}],"_postman_id":"bf0af0c3-8493-4a2f-b22b-667bb294468e"},{"name":"Get Ruleset Template ID","id":"48f92216-a5b8-4e8a-99c3-ed4a1f354906","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/workspaces/:{{workspace_id}}/ruleset_templates","description":"

This API retrieves a list of ruleset templates and their IDs in a workspace.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"list_info\":{\"start_index\":1,\"row_count\":100,\"sort_field\":\"created_time\",\"sort_order\":\"desc\"}}

Note: Please make sure the input data is encoded.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example values	Description	Mandatory
list_info	object	`{ \"...\" }`	Contains settings for pagination and sorting of the ruleset templates.	Yes
list_info.start_index	number	`1`	Specifies the starting index of the records to return (pagination control).	Yes
list_info.row_count	number	`100`	Maximum number of records to return in a single request.	Yes
list_info.sort_field	string	`created_time`	Field name used to sort the results.	Yes
list_info.sort_order	string	`desc`	Sort order of the results (`desc` = latest first, `asc` = oldest first).	No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","workspaces",":{{workspace_id}}","ruleset_templates"],"host":["{{whitelabel_domain}}"],"query":[{"disabled":true,"description":{"content":"

sample input

\n","type":"text/plain"},"key":"input_data","value":"%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%7D%7D"}],"variable":[{"id":"a0a62554-2eaf-496d-8e14-87036b5a6eac","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"8a06010b-c921-4ce5-9290-e0362ccd6dcb","description":{"content":"

Provide the ID of your workspace. You can get it using the Get Workspaces API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{workspace_id}}"}]}},"response":[{"id":"29aa7bf6-57d8-456f-8fb6-dc3f2e1e44fa","name":"Get Ruleset Template ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dataprep.sample.com/api/v1/portals/samplewl/workspaces/5531700000092099/ruleset_templates?input_data=%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%7D%7D","protocol":"https","host":["dataprep","sample","com"],"path":["api","v1","portals","samplewl","workspaces","5531700000092099","ruleset_templates"],"query":[{"key":"input_data","value":"%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%7D%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the ruleset template id under the section, \"rulesettemplates\"\n{\n \"rulesettemplates\": [\n {\n \"id\": \"55317000000155185\",\n \"name\": \"test\",\n \"description\": \"Sales data rules\",\n \"created_by\": {\n \"id\": \"55317000000011001\",\n \"zuid\": \"10101627824\",\n},/////\n"}],"_postman_id":"48f92216-a5b8-4e8a-99c3-ed4a1f354906"},{"name":"Apply saved ruleset template","id":"cd53d8d5-c0f9-4d5a-8e73-1ba3c596bfc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rulesettemplate\":\"55317000000155185\",\"includeParseDetails\":false}","description":"

sample input

\n","type":"text","uuid":"bc690fbe-6b98-4df7-82b8-97d38c825baa"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}} /rulesetaudits/:{{sample_id}}/apply_ruleset_template ","description":"

This API is used to apply a saved ruleset template to a dataset or stage in a workspace.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input

{\"rulesettemplate\":\"55317000000155185\",\"includeParseDetails\":false}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example values	Description	Mandatory
rulesettemplate	string	55317000000155185	The unique ID of the ruleset template you want to apply. You can get this ID using the Get Ruleset Templates ID API.	Yes
includeParseDetails	boolean	false	Indicates whether parsing details should be included when applying the ruleset template. `true` includes parsing details; `false` excludes them.	No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}} ","rulesetaudits",":{{sample_id}}","apply_ruleset_template "],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"631b9da6-ae72-4d4d-8205-26105e61a2c5","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}} "},{"id":"1a2d13fc-e230-40ee-88a4-e51384ae804f","description":{"content":"

Provide the sample ID of the stage where you want to apply the ruleset template. You can get it from the response Get pipelines info API.

Steps to get sample_id:

In the Pipeline info response, locate the Transform task (type = 10) in pipelinetasks
\n
Navigate through the nested objects: dataset → selected_sample.
\n
Use the value of selected_sample.id as the {sample_id}.
\n

\n","type":"text/plain"},"type":"any","value":"string","key":"{{sample_id}}"}]}},"response":[{"id":"9ddd5fc1-6773-437d-a174-cad1ad26a5a6","name":"Apply saved ruleset template","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rulesettemplate\":\"55317000000155185\",\"includeParseDetails\":false} ","description":"sample input","type":"text","uuid":"18f082e8-15ca-465b-8474-c774e8b2d150"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/datasetsamples/55317000000092267/applytemplate "},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n\n \"datasetsample\": {\n\n \"id\": \"55317000000092267\",\n\n \"dataset\": {\n\n \"id\": \"55317000000092255\",\n\n \"name\": \"SampleFTP\",\n\n \"description\": null,\n\n \"status\": 1,\n\n \"is_ready\": false,\n\n \"is_pii_marked\": false,\n\n \"project\": {\n\n \"id\": \"55317000000092099\"\n\n },\n\n \"selected_sample\": {\n\n \"id\": \"55317000000092267\"\n\n },////"}],"_postman_id":"cd53d8d5-c0f9-4d5a-8e73-1ba3c596bfc5"},{"name":"Import ruleset template file","id":"0e200a40-1e36-4587-a64e-dbf8a0c7dcd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"filename-(binary)","type":"text","uuid":"bc690fbe-6b98-4df7-82b8-97d38c825baa","description":"

sample input

\n"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/uploads/import_ruleset_template","description":"

Import Ruleset Template File

This API is used to import a ruleset template into the current stage.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input
filename-(binary)

Note: Upload the file in the request body.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"}]}},"response":[{"id":"25d89627-d5d5-4769-af3d-9130e6ec8249","name":"Import ruleset template file","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rulesettemplate\":\"55317000000155185\",\"includeParseDetails\":false} ","description":"sample input","type":"text","uuid":"18f082e8-15ca-465b-8474-c774e8b2d150"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/uploads/import_ruleset_template"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You will get the upload id from the response\n{\n \"upload\": {\n \"id\": \"55317000000158273\",\n },\n },/////\n \"name\": \"sample.zdrt\",\n \"file\": {\n \"id\": \"55317000000158271\",\n \"datastore_id\": \"3\",\n \"path\": \"dataprep/10101402532/import_449345521.zdrt?blockId=NN112:-8350912051415458994&resourceId=0006ts819mv3wpyb604z75dwme\",\n \"status\": 1\n },/////"}],"_postman_id":"0e200a40-1e36-4587-a64e-dbf8a0c7dcd2"},{"name":"Apply ruleset template from file","id":"3b3c438b-c15d-471a-a648-d2acc78c6641","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"upload_id\":\"55317000000155313\",\"includeParseDetails\":false}","description":"

sample input

\n","type":"text","uuid":"d66fb520-a793-4765-952f-5809bbee4fea"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasetsamples/:{{sample_id}}/apply_ruleset_template_file","description":"

This API is used to apply a ruleset template from an imported .zdrt file to the current stage.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input

{\"rulesettemplate\":\"55317000000155185\",\"includeParseDetails\":false}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example values	Description	Mandatory
upload_id	string	`55317000000155313`	The unique ID of the uploaded ruleset template file. This ID is obtained from the Import Ruleset Template File API response.	Yes
includeParseDetails	boolean	`false`	Determines whether parsing details should be included when applying the uploaded ruleset template. • `true` – include parsing details • `false` – exclude parsing details	No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","datasetsamples",":{{sample_id}}","apply_ruleset_template_file"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"74ef4463-4651-4bc9-9fcf-b4715e125b6d","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"0f851fd0-1215-4970-8b4e-7b9a3f30d7c4","description":{"content":"

Provide the sample ID of the stage where you want to apply a transform. You can get from the response Get pipelines info API.\nSteps to get sample_id:

In the Pipeline info response, locate the Transform task (type = 10) in pipelinetasks
Navigate through the nested objects: dataset → selected_sample.
Use the value of selected_sample.id as the {sample_id}.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{sample_id}}"}]}},"response":[{"id":"8dbd6629-e218-4a25-952a-6284720e5932","name":"Apply saved ruleset template from file","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"upload_id\":\"55317000000155313\",\"includeParseDetails\":false}","description":"sample input","type":"text","uuid":"18f082e8-15ca-465b-8474-c774e8b2d150"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/datasetsamples/55317000000110051/apply_ruleset_from_file"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"datasetsample\": {\n \"id\": \"55317000000110051\",\n \"dataset\": {\n },\n \"project\": {\n },\n \"selected_sample\": {\n \"id\": \"55317000000110051\"\n }\n },\n \"current_rule\": {\n \"id\": \"55317000000155209\",\n \"rule_json\": \"{\\\"name\\\":\\\"setprivacy\\\",\\\"params\\\":{\\\"colList\\\":[{\\\"col\\\":\\\"age\\\",\\\"personalInfo\\\":{\\\"pii\\\":true}}]},\\\"meta\\\":null,\\\"pointer\\\":55317000000155169}\",\n \"type\": \"TRANSFORM_RULE\",\n \"description\": null,\n \"created_time\": \"1765993540674\",\n \"created_by\": {\n \"id\": \"55317000000011001\"\n }\n },/////"}],"_postman_id":"3b3c438b-c15d-471a-a648-d2acc78c6641"},{"name":"Export Ruleset as .zdrt file","id":"1bd1418d-076c-4ab3-a4f5-6ba0b30f5bd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"test\",\"description\":\"test\",\"includeParseDetails\":true}","description":"

sample input

\n","type":"text","uuid":"b4043dc6-4832-4d03-95c2-90b5d3f2bca9"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/rulesetaudits/:{{rulesetaudit_id}}/export_ruleset","description":"

This API is used to export the ruleset template as a .zdrt file.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input

{\"name\":\"test\",\"description\":\"test ruleset\",\"includeParseDetails\":true}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example values	Description	Mandatory
name	string	`test`	Name of the ruleset template.	Yes
description	string	`test ruleset`	Description providing details about the ruleset template.	No
includeParseDetails	boolean	`true`	Specifies whether parsing details should be included when saving the ruleset template.	No

Export selected rules in a template:

This is used to export only specific rules from a dataset’s ruleset as a template.

To export selected rules in a template use the same Export Ruleset API with rulesetaudit_id in the path and the input provided below.

Sample input

{\"name\":\"selectedrules\",\"description\":\"test\",\"includeParseDetails\":false,\"params\":{\"rules\":[\"55317000000067023\",\"55317000000067129\"]}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
`name`	String	`\"selectedrules\"`	Export type for selected rules.	✅ Yes
`description`	String	`\"Export only join and filter rules\"`	Description for exported template/file.	❌ No
`includeParseDetails`	Boolean	`true` / `false`	Whether to include parse-level details.	❌ No
`params`	Object	`{ \"rules\": [...] }`	Parameters for selected rule export.	✅ Yes
`params.rules`	Array of String	`[\"55317000000067023\",\"55317000000067129\"]`	List of rule IDs to be exported.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","rulesetaudits",":{{rulesetaudit_id}}","export_ruleset"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"44b744e1-0bc6-4b0d-afa5-1d8b89c94d25","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"837c8398-b915-4342-a642-4ee42197a39e","description":{"content":"

Provide the Ruleset Audit ID of the stage where you want to apply the transform.

You can find the ruleset_audit id under the id field within the rulesetaudit key from the Get Ruleset history API response. \nIn the response, you can find the ruleset_audit ID under the id field within the rulesetaudit key.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{rulesetaudit_id}}"}]}},"response":[{"id":"e115d5a7-c382-4d26-8343-59c807b2f74d","name":"Export Ruleset as .zdrt file","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"test\",\"description\":\"test\",\"includeParseDetails\":true}","type":"text","uuid":"18f082e8-15ca-465b-8474-c774e8b2d150"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/rulesetaudits/55317000000155255/export"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"rsauditfile\": {\n \"id\": \"55317000000155365\",\n \"created_time\": \"1766002665165\",\n \"status\": 1,\n \"file_size\": \"563\"\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n ]\n }\n}"}],"_postman_id":"1bd1418d-076c-4ab3-a4f5-6ba0b30f5bd0"},{"name":"Schedule pipeline","id":"e4bcd34b-324a-49d8-a89d-7d09ec4c06db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rep_info\":{\"rep_type\":\"hourly\",\"freq\":\"1\",\"past\":\"0\"},\"timeZone\":\"GMT +05:30 Asia/Kolkata\",\"schpipelineconfig\":{\"skip_export_invalid_data\":false},\"pipeline_run_config\":{}}","type":"text","uuid":"b4043dc6-4832-4d03-95c2-90b5d3f2bca9","description":"

sample input

\n"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/schedule","description":"

This API is used to configure and schedule a pipeline to run at specified intervals in a workspace.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input

{\"rep_info\":{\"rep_type\":\"hourly\",\"freq\":\"1\",\"past\":\"0\"},\"timeZone\":\"GMT +05:30 Asia/Kolkata\",\"schpipelineconfig\":{\"skip_export_invalid_data\":false},\"pipeline_run_config\":{}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example values	Description	Mandatory
rep_info	object	`{ \"...\" }`	Contains scheduling and recurrence details for the scheduled pipeline run.	Yes
rep_info.rep_type	string	`hourly`, `daily`, `weekly`, `monthly`	Specifies the recurrence type for the schedule.	Yes
rep_info.freq	string	`1`	Defines the frequency of the recurrence (e.g., `1` = every hour/day).	Yes
rep_info.past	string	`0`	Indicates whether past runs should be considered (`0` = future only).	No
timeZone	string	`GMT +05:30 Asia/Kolkata`	Time zone in which the scheduled pipeline run will be executed.	Yes
schpipelineconfig	object	`{ \"...\" }`	Configuration settings for the scheduled pipeline execution.	No
schpipelineconfig.skip_export_invalid_data	boolean	`false`	Specifies whether records with invalid data should be skipped during export.	No
pipeline_run_config	object	`{}`	Additional runtime configuration for the scheduled pipeline run. Empty uses defaults.	No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","pipelines",":{{pipeline_id}}","schedule"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"cdfbb98b-bf88-4498-93e0-ad63766c89f1","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"8274a6ae-cc22-42ff-890f-d42b45e2983f","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"c82157dc-1119-405e-9257-19286cb8942e","name":"Schedule pipeline","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rep_info\":{\"rep_type\":\"hourly\",\"freq\":\"1\",\"past\":\"0\"},\"timeZone\":\"GMT +05:30 Asia/Kolkata\",\"schpipelineconfig\":{\"skip_export_invalid_data\":false},\"pipeline_run_config\":{}}","description":"sample input","type":"text","uuid":"18f082e8-15ca-465b-8474-c774e8b2d150"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelines/55317000000155369/schedule"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"scheduler\": {\n \"55317000000155369\": {\n \"pipelineschedule\": {\n \"id\": \"55317000000155531\",\n \"created_by\": {\n \"id\": \"55317000000011001\",\n },\n },\n},\n \"scheduler\": {\n \"id\": \"55317000000155527\",\n \"name\": \"55317000000155369_ZSPipelineScheduleTask\",\n \"class_name\": \"com.zoho.streamline.taskengine.task.ZSPipelineScheduleTask\",\n \"rep_name\": \"1_hours_0_past\",\n \"job_type\": \"REPETITIVE\",\n \"rep_type\": \"PERIODIC\",\n \"rep_freq\": \"HOURS\",\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n }\n },\n}/////"}],"_postman_id":"e4bcd34b-324a-49d8-a89d-7d09ec4c06db"},{"name":"Get stage output details","id":"128b5138-fc32-4726-aced-0139201585d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasetexports/:{{dataset_export_id}}/Output_details","description":"

This API is used to retrieve and download the output data generated for a specific stage from the job summary.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"4409f5ef-4105-4284-b042-e9eb187a014d","description":{"content":"

The dataset export ID generated for your export activity. You can retrieve this value from the response of the Pipeline info API.

To get the dataset_export_id:

In the Pipeline Info response, locate the Export task within the pipelinetasks array.
Identify the task element that contains the datasetexport object.
Navigate through the nested object: datasetexport → id.
Use the value of datasetexport.id as the Dataset Export ID.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{dataset_export_id}}"}]}},"response":[{"id":"47a0abe5-f79b-4189-acfe-ba293526da15","name":"Get stage output details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://dataprep.sample.com/api/v1/portals/samplewl/datasetexports/55317000000076269/details"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the output details under the \"datasetexport\" section\n{\n \"datasetexport\": {\n \"catalog\": {\n \"EXPORTTYPE\": \"FILE\",\n \"FILEFORMAT\": \"CSV\",\n \"COMPRESSED\": false,\n\t\"OUTFILE\": \"Company\",\n \"ROW_SEPARATOR\": \"UNIX\",\n \"QUALIFIER\": \"double\",\n \"CHARSET\": \"UTF-8\",\n \"DELIMITER\": \",\",\n \"INCLUDED_PII_COLS\": [],\n \"INCLUDE_TYPE\": \"all\",\n \"datasetid\": 55317000000076061\n },\n},\n},///\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n },///"}],"_postman_id":"128b5138-fc32-4726-aced-0139201585d3"},{"name":"Trash pipeline","id":"0e2486ad-9844-4c79-9aa1-f1bba3958a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/trash","description":"

This API is used to trash a pipeline in a workspace.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"45ca54cb-1c7c-4dad-8742-8374c2cffb8c","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"1d470c28-d7be-486c-91d8-258208502af5","name":"Trash pipeline","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"url":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelines/55317000000155369/move_to_trash"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"pipeline\": {\n \"id\": \"55317000000155369\",\n \"name\": \"My pipeline-1\",\n \"description\": null,\n },\n }, \n},\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n}/////"}],"_postman_id":"0e2486ad-9844-4c79-9aa1-f1bba3958a8e"},{"name":"Permanently delete pipeline","id":"ba316d20-ac32-41f2-84fd-7be13af6818b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/permanent_delete","description":"

This API deletes a pipeline from a workspace permanently.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"8c2333af-511b-421b-bb89-4382b46072f9","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"0a46767f-78be-4c97-bbfb-1bd7611880f7","name":"Permanently delete pipeline","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelines/55317000000156201/remove"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n ]\n }\n}"}],"_postman_id":"ba316d20-ac32-41f2-84fd-7be13af6818b"},{"name":"Trash workspace","id":"56364002-714a-4fb1-be33-df6dbafc5ddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/workspace/:{{workspace_id}}/trash","description":"

This API is used to trash a workspace.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"3df24f18-562f-4815-81a5-1cfd4f916758","description":{"content":"

Provide the ID of your workspace. You can get it using the Get workspaces API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{workspace_id}}"}]}},"response":[{"id":"3cb3b1de-a035-4481-956e-bfecde9bfe11","name":"Trash workspace","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"url":"https://dataprep.sample.com/api/v1/portals/samplewl/projects/55317000000079163/move_to_trash"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"project\": {\n \"id\": \"55317000000079163\",\n \"name\": \"My Workspace-5\",\n \"description\": null,\n }\n}\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n},//////"}],"_postman_id":"56364002-714a-4fb1-be33-df6dbafc5ddb"},{"name":"Permanently delete workspace","id":"2bae89da-3c5c-4182-a571-f83471716e8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/workspace/:{{workspace_id}}/permanent_delete","description":"

This API deletes a workspace permanently.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"855d3eaf-3016-4588-91be-0b5f95c54f74","description":{"content":"

Provide the ID of your workspace. You can get it using the Get workspaces API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{workspace_id}}"}]}},"response":[{"id":"e68dec4b-7284-4bab-b52f-321e223d8bf9","name":"Permanently delete workspace","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://dataprep.sample.com/api/v1/portals/samplewl/projects/55317000000156725/remove"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n }\n ]\n }\n}"}],"_postman_id":"2bae89da-3c5c-4182-a571-f83471716e8f"},{"name":"Delete stage","id":"36107f3a-6fbe-4f23-8c11-765ec53129e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/remove_stage?input_data=%7B%22dataset%22%3A%2255317000000156551%22%7D","description":"

This API is used to delete a stage from a pipeline.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input

{\"dataset\":\"55317000000156551\"}

dataset - The unique ID of the dataset or stage to be deleted. You can get this ID from the Get Pipeline Info API response.

Note: Please make sure the input data is encoded.

Steps to get dataset_id:

1. In the Pipeline Info response, locate the pipeline task within the pipelinetasks array

2. Identify Transform task or an Export task.

3. Navigate through the nested object based on the task type:

4. For Transform tasks: dataset → id

5. For Export tasks: datasetexport → dataset → id

sample input

\n","type":"text/plain"},"key":"input_data","value":"%7B%22dataset%22%3A%2255317000000156551%22%7D"}],"variable":[{"id":"40e4ef31-7fdb-4172-8714-daad26f86785","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"499ef188-6f12-4f04-93d3-40637fb255fc","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"655575c6-01a3-4cac-be11-18addc22cb48","name":"Delete stage","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelines/55317000000156337/remove_dataset?input_data=%7B%22dataset%22%3A%2255317000000156551%22%7D","protocol":"https","host":["dataprep","sample","com"],"path":["api","v1","portals","samplewl","pipelines","55317000000156337","remove_dataset"],"query":[{"key":"input_data","value":"%7B%22dataset%22%3A%2255317000000156551%22%7D","description":"sample input"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"pipelinetask\": {\n \"id\": \"55317000000156577\",\n \"name\": \"Sample_leads-4_derived_dataset\",\n \"type\": 10,\n \"pipeline\": {\n \"id\": \"55317000000156337\"\n },\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000,\n \"messages\": [\n {\n \"type\": \"success\",\n \"status_code\": 2000\n },/////"}],"_postman_id":"36107f3a-6fbe-4f23-8c11-765ec53129e0"},{"name":"Clone pipeline","id":"1d831550-48c0-43e5-af40-b12336bafafc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"pipeline_name\":\"My pipeline-2 2025-12-18 12:50:57.533\"}","type":"text","uuid":"b4043dc6-4832-4d03-95c2-90b5d3f2bca9","description":"

sample input

\n"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/clone","description":"

This API is used to create a copy of an existing pipeline with the same configuration and stages.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input

{\"pipeline_name\":\"My pipeline-2 2025-12-18 12:50:57.533\"}

Name of the new pipeline to be created during the clone operation.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"f3931e38-60ce-404b-bede-6f06fe3fdbc6","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"425d1241-47aa-44b9-afaf-8dcf36229124","name":"Clone pipeline","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"pipeline_name\":\"My pipeline-2 2025-12-18 12:50:57.533\"}","type":"text","uuid":"18f082e8-15ca-465b-8474-c774e8b2d150"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://dataprep.sample.com/api/v1/portals/samplewl/pipelines/55317000000156337/duplicate?input_data={\"pipeline_name\":\"My pipeline-2 2025-12-18 12:50:57.533\"}","protocol":"https","host":["dataprep","sample","com"],"path":["api","v1","portals","samplewl","pipelines","55317000000156337","duplicate"],"query":[{"key":"input_data","value":"{\"pipeline_name\":\"My pipeline-2 2025-12-18 12:50:57.533\"}","description":"sample input"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"pipeline\": {\n \"id\": \"55317000000156597\",\n \"name\": \"My pipeline-2 2025-12-18 12:50:57.533\",\n \"description\": null,\n \"created_by\": {\n},//////"}],"_postman_id":"1d831550-48c0-43e5-af40-b12336bafafc"},{"name":"Clone workspace","id":"cefd1a99-7e9f-4306-801f-6c0ffd00f341","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project_name\":\"My Workspace-8 2025-12-18 15:01:36.164\"}","type":"text","uuid":"b4043dc6-4832-4d03-95c2-90b5d3f2bca9","description":"

sample input

\n"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/workspace/:{{workspace_id}}/clone","description":"

This API is used to create a copy of an existing pipeline with the same configuration and stages.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input

{\"project_name\":\"My Workspace-8 2025-12-18 15:01:36.164\"}

project_name - Name of the new workspace to be created during the clone operation.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"355079a3-1d63-40d9-b8da-db31861aa4dd","description":{"content":"

Provide the ID of your workspace. You can get it using the Get workspaces API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{workspace_id}}"}]}},"response":[{"id":"7210d7dc-be07-4ae2-9804-5f96c4505ff5","name":"Clone workspace","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project_name\":\"My Workspace-8 2025-12-18 15:01:36.164\"}","type":"text","uuid":"18f082e8-15ca-465b-8474-c774e8b2d150"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.sample.com/api/v1/portals/samplewl/projects/55317000000092099/duplicate"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"pipeline\": {\n \"id\": \"55317000000156597\",\n \"name\": \"My pipeline-2 2025-12-18 12:50:57.533\",\n \"description\": null,\n \"created_by\": {\n},//////"}],"_postman_id":"cefd1a99-7e9f-4306-801f-6c0ffd00f341"},{"name":"Mark as ready","id":"68871cc7-91cd-4437-b653-b97aa0db309b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/mark_as_ready","description":"

The Mark as Ready API is used to finalize a pipeline and mark it as ready before scheduling or running a pipeline.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"2d2ea760-e7db-4421-8270-08254c17ea62","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"3c3719e6-2cb9-4d40-a43b-281499ad45a4","name":"Mark as ready","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/pipelines/55317000000058553/mark_as_ready"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"\n{\n \"pipelineaudit\": {\n \"id\": \"55317000000124509\",\n \"created_time\": \"1765433269185\",\n \"modtime\": \"1766122338757\",\n \"is_committed\": 1,\n \"pipeline\": {\n \"id\": \"55317000000058553\",\n \"name\": \"My pipeline-1\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": true,\n \"depends_on_past\": false\n },//////"}],"_postman_id":"68871cc7-91cd-4437-b653-b97aa0db309b"},{"name":"Connection ID","id":"980db974-26b6-45ef-b0a4-d4599f4df094","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/connections","description":"

This API is used to get the connection ID of the S3/FTP account from where you want to import your file.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Query parameters :

To navigate around the data from response, list_info can be provided in the input data. Here's a sample of the input data with list_info:

Note: Please make sure the input data is encoded.

Sample Input

{\"list_info\":{\"start_index\":1,\"row_count\":100,\"sort_field\":\"created_time\",\"sort_order\":\"desc\",\"search_criteria\":{\"field\":\"type\",\"value\":\"1\",\"condition\":\"neq\",\"children\":[{\"field\":\"name\",\"condition\":\"neq\",\"values\":[\"Zoho Analytics\",\"Zoho workdrive\",\"Zoho MEAPlus\"],\"logical_operator\":\"AND\",\"children\":[{\"condition\":\"neq\",\"field\":\"type\",\"logical_operator\":\"AND\",\"values\":[20,11]},{\"condition\":\"eq\",\"field\":\"status\",\"logical_operator\":\"AND\",\"values\":[1,-3]}]}]},\"filter_by\":{\"name\":\"trash\",\"filter\":\"getAll\"},\"scope\":\"owned\"}}

Key	Type	Variables (Possible / Example)	Description	Mandatory
`list_info.start_index`	Number	≥ 1 (Example: `1`)	Starting index for pagination.	✅ Yes
`list_info.row_count`	Number	`1–100` (Example: `100`)	Number of records to fetch.	✅ Yes
`list_info.sort_field`	String	`created_time`	Field used for sorting results.	❌ No
`list_info.sort_order`	String	`asc`, `desc` (Example: `desc`)	Sort order of the results.	❌ No
`list_info.search_criteria.field`	String	Example: `type`	Field used for the search condition.	❌ No
`list_info.search_criteria.value`	String	Example: `1`	Value to be compared against the field.	❌ No
`list_info.search_criteria.condition`	String	`eq`, `neq`	Condition applied on the field.	❌ No
`list_info.search_criteria.children`	Array	Nested criteria objects	Additional search filters combined logically.	❌ No
`list_info.search_criteria.children.field`	String	Example: `name`, `type`, `status`	Field used in the nested condition.	❌ No
`list_info.search_criteria.children.condition`	String	`eq`, `neq`	Condition for the nested field.	❌ No
`list_info.search_criteria.children.values`	Array	Example: `[\"Zoho Analytics\"]`, `[1, -3]`	Values to evaluate against the field.	❌ No
`list_info.search_criteria.children.logical_operator`	String	`AND`, `OR`	Logical operator for combining conditions.	❌ No
`filter_by.name`	String	Example: `trash`	Filter category.	❌ No
`filter_by.filter`	String	Example: `getAll`	Filter action to apply.	❌ No
`scope`	String	`owned`, `shared`	Scope of records to be fetched.	❌ No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","connections"],"host":["{{whitelabel_domain}}"],"query":[{"disabled":true,"description":{"content":"

sample input

\n","type":"text/plain"},"key":"input_data","value":"%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%2C%22search_criteria%22%3A%7B%22field%22%3A%22type%22%2C%22value%22%3A%221%22%2C%22condition%22%3A%22neq%22%2C%22children%22%3A%5B%7B%22field%22%3A%22name%22%2C%22condition%22%3A%22neq%22%2C%22values%22%3A%5B%22Zoho%20Analytics%22%2C%22Zoho%20workdrive%22%2C%22Zoho%20MEAPlus%22%5D%2C%22logical_operator%22%3A%22AND%22%2C%22children%22%3A%5B%7B%22condition%22%3A%22neq%22%2C%22field%22%3A%22type%22%2C%22logical_operator%22%3A%22AND%22%2C%22values%22%3A%5B20%2C11%5D%7D%2C%7B%22condition%22%3A%22eq%22%2C%22field%22%3A%22status%22%2C%22logical_operator%22%3A%22AND%22%2C%22values%22%3A%5B1%2C-3%5D%7D%5D%7D%5D%7D%2C%22filter_by%22%3A%7B%22name%22%3A%22trash%22%2C%22filter%22%3A%22getAll%22%7D%2C%22scope%22%3A%22owned%22%7D%7D"}],"variable":[{"id":"3bf83c5c-1780-4e37-82d0-564463c88b18","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"}]}},"response":[{"id":"7920d575-406a-466e-afb5-a5ddf331764e","name":"Connection ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/connections?input_data=%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%2C%22search_criteria%22%3A%7B%22field%22%3A%22type%22%2C%22value%22%3A%221%22%2C%22condition%22%3A%22neq%22%2C%22children%22%3A%5B%7B%22field%22%3A%22name%22%2C%22condition%22%3A%22neq%22%2C%22values%22%3A%5B%22Zoho%20Analytics%22%2C%22Zoho%20workdrive%22%2C%22Zoho%20MEAPlus%22%5D%2C%22logical_operator%22%3A%22AND%22%2C%22children%22%3A%5B%7B%22condition%22%3A%22neq%22%2C%22field%22%3A%22type%22%2C%22logical_operator%22%3A%22AND%22%2C%22values%22%3A%5B20%2C11%5D%7D%2C%7B%22condition%22%3A%22eq%22%2C%22field%22%3A%22status%22%2C%22logical_operator%22%3A%22AND%22%2C%22values%22%3A%5B1%2C-3%5D%7D%5D%7D%5D%7D%2C%22filter_by%22%3A%7B%22name%22%3A%22trash%22%2C%22filter%22%3A%22getAll%22%7D%2C%22scope%22%3A%22owned%22%7D%7D","protocol":"https","host":["dataprep","zylker","com"],"path":["api","v1","portals","zylkerwl","connections"],"query":[{"key":"input_data","value":"%7B%22list_info%22%3A%7B%22start_index%22%3A1%2C%22row_count%22%3A100%2C%22sort_field%22%3A%22created_time%22%2C%22sort_order%22%3A%22desc%22%2C%22search_criteria%22%3A%7B%22field%22%3A%22type%22%2C%22value%22%3A%221%22%2C%22condition%22%3A%22neq%22%2C%22children%22%3A%5B%7B%22field%22%3A%22name%22%2C%22condition%22%3A%22neq%22%2C%22values%22%3A%5B%22Zoho%20Analytics%22%2C%22Zoho%20workdrive%22%2C%22Zoho%20MEAPlus%22%5D%2C%22logical_operator%22%3A%22AND%22%2C%22children%22%3A%5B%7B%22condition%22%3A%22neq%22%2C%22field%22%3A%22type%22%2C%22logical_operator%22%3A%22AND%22%2C%22values%22%3A%5B20%2C11%5D%7D%2C%7B%22condition%22%3A%22eq%22%2C%22field%22%3A%22status%22%2C%22logical_operator%22%3A%22AND%22%2C%22values%22%3A%5B1%2C-3%5D%7D%5D%7D%5D%7D%2C%22filter_by%22%3A%7B%22name%22%3A%22trash%22%2C%22filter%22%3A%22getAll%22%7D%2C%22scope%22%3A%22owned%22%7D%7D","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the connection id under the key \"connections\".\n\n{\n \"connections\": [\n{...},\n{...},\n{\n \"id\": \"55317000000042951\",\n \"name\": \"amazons3\",\n \"connection_json\": {\n \"is_authorised\": true\n },/////////"}],"_postman_id":"980db974-26b6-45ef-b0a4-d4599f4df094"},{"name":"Add Connection","id":"28f8d403-b940-43a3-b320-d63f041e8f2f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept":true,"connection":true,"accept-encoding":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"connection\":{\"name\":\"test FTP\",\"connection_json\":\"{\\\"ftpservertype\\\":\\\"SSH\\\",\\\"hostname\\\":\\\"ec2-*****\\\",\\\"port\\\":\\\"22\\\",\\\"ftp_auth_type\\\":\\\"0\\\",\\\"username\\\":\\\"data****\\\",\\\"password\\\":\\\"datap****\\\"}\",\"type\":4}}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/connections","description":"

The Add Connection API is used to create and configure a new data connection in a pipeline. It enables users to connect external data sources securely or destinations so they can be used in pipelines for data import, or export.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample Input

For S3

{\"connection\":{\"name\":\"Test\",\"connection_json\":\"{\\\"accessKey\\\":\\\"AKIAQE2RKAGK\\* \\\",\\\"secretKey\\\":\\\"48e83OC8LY9yCpwcHgY\\*\\\"}\",\"type\":15}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description	Mandatory
`connection.name`	String	Name of the S3 connection.	✅ Yes
`connection.type`	Integer	Connection type identifier for Amazon S3 (`15`).	✅ Yes
`connection.connection_json.accessKey`	String	AWS Access Key ID.	✅ Yes
`connection.connection_json.secretKey`	String	AWS Secret Access Key.	✅ Yes

For FTP

{\"connection\":{\"name\":\"test FTP\",\"connection_json\":\"{\\\"ftpservertype\\\":\\\"SSH\\\",\\\"hostname\\\":\\\"ec2-\\*\\\",\\\"port\\\":\\\"22\\\",\\\"ftp_auth_type\\\":\\\"0\\\",\\\"username\\\":\\\"data****\\\",\\\"password\\\":\\\"datap****\\\"}\",\"type\":4}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description	Mandatory
`connection.name`	String	Name of the FTP connection.	✅ Yes
`connection.type`	Integer	Connection type identifier for FTP (`4`).	✅ Yes
`connection.connection_json.ftpservertype`	String	FTP server type (Example: `SSH`, `FTP`, `SFTP`).	✅ Yes
`connection.connection_json.hostname`	String	Hostname or IP address of the FTP server.	✅ Yes
`connection.connection_json.port`	String	Port number of the FTP server.	✅ Yes
`connection.connection_json.ftp_auth_type`	String	FTP authentication type (Example: password‑based).	✅ Yes
`connection.connection_json.username`	String	Username for FTP authentication.	✅ Yes
`connection.connection_json.password`	String	Password for FTP authentication.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","connections"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"c01445ea-6bc7-44fa-b098-a8698a44be24","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"}]}},"response":[{"id":"f8f8bb46-0df3-462b-bb71-4688defb3e3e","name":"Add Connection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"connection\":{\"name\":\"test FTP\",\"connection_json\":\"{\\\"ftpservertype\\\":\\\"SSH\\\",\\\"hostname\\\":\\\"ec2-*****\\\",\\\"port\\\":\\\"22\\\",\\\"ftp_auth_type\\\":\\\"0\\\",\\\"username\\\":\\\"data****\\\",\\\"password\\\":\\\"datap****\\\"}\",\"type\":4}}","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/connections"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the connection id under the key \"connections\".\n\n{\n \"connection\": {\n \"id\": \"55317000000160009\",\n \"name\": \"test FTP\",\n \"connection_json\": {\n \"ftpservertype\": \"SSH\",\n \"hostname\": \"ec2-******\",\n \"port\": \"22\",\n \"ftp_auth_type\": \"0\",\n \"username\": \"dataprepsftp\",\n \"is_authorised\": true\n },\n \"type\": \"4\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110790782\",\n \"username\": \"*******\",\n \"email_id\": \"i*****@zohocorp.com\",\n \"base_type\": \"SSH\",\n \"sub_type\": null\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n}"}],"_postman_id":"28f8d403-b940-43a3-b320-d63f041e8f2f"},{"name":"Initiate import","id":"85df666f-4309-4132-9322-85ab0fb57809","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"connection\":{\"name\":\"test FTP\",\"connection_json\":\"{\\\"ftpservertype\\\":\\\"SSH\\\",\\\"hostname\\\":\\\"ec2-*****\\\",\\\"port\\\":\\\"22\\\",\\\"ftp_auth_type\\\":\\\"0\\\",\\\"username\\\":\\\"data****\\\",\\\"password\\\":\\\"datap****\\\"}\",\"type\":4}}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/connections/:{{connection_id}}/import","description":"

This API is used to start the import process from the selected S3/FTP connection using the connection ID.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample Input

For simple selection Amazon S3

{\"name\":\"WebLeads.csv\",\"project_id\":\"55317000000022199\",\"replication_type\":\"1\",\"catalog\":{\"0\":{\"bucket\":\"leads2025\",\"path\":\"/WebLeads.csv\",\"name\":\"WebLeads.csv\"}},\"feature_name\":\"import\",\"feature_type\":\"0:amazons3\"}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`name`	String	`\"WebLeads.csv\"`	Name of the file to be imported.	✅ Yes
`project_id`	String	`\"55317000000022199\"`	Workspace ID in which the file will be imported.	✅ Yes
`replication_type`	String	`\"1\"`	Type of import / replication.	❌ No
`catalog`	Object	`{\"0\": { ... }}`	Holds the Amazon S3 file details.	✅ Yes
`catalog.0.bucket`	String	`\"leads2025\"`	Name of the S3 bucket where the file is located.	✅ Yes
`catalog.0.path`	String	`\"/WebLeads.csv\"`	Path of the file inside the S3 bucket.	✅ Yes
`catalog.0.name`	String	`\"WebLeads.csv\"`	File name as it appears in S3.	✅ Yes
`feature_name`	String	`\"import\"`	Indicates the feature being used.	✅ Yes
`feature_type`	String	`\"0:amazons3\"`	Connection type used for import (Amazon S3).	✅ Yes

INPUT for incremental fetch-Amazon S3

Sample:

{\"name\":\"Company.csv\",\"project_id\":\"55317000000022199\",\"replication_type\":\"1\",\"catalog\":{\"0\":{\"name\":\"Company.csv\",\"bucket\":\"leads2025\",\"multi_audit_import\":true,\"file_name_pattern\":\"Company.\\\\\\*\",\"include_subfolders\":false,\"fetch_only_incremental_files\":true,\"mergeFiles\":false,\"fetch_incremented_data\":true,\"parseas\":\"csv\",\"path\":\"/\"}},\"feature_name\":\"import\",\"feature_type\":\"0:amazons3\"}

Key	Type	Variables / Example Values	Description	Mandatory
`name`	String	`Company.csv`	Name of the file to be imported.	✅ Yes
`project_id`	String	`55317000000022199`	Workspace where the file is being imported.	✅ Yes
`replication_type`	String	`1`	Indicates the type of import.	❌ No
`catalog`	Object	`{\"0\": { ... }}`	Holds the Amazon S3 file details.	✅ Yes
`catalog.0.name`	String	`Company.csv`	File name in Amazon S3.	✅ Yes
`catalog.0.bucket`	String	`leads2025`	Name of the S3 bucket.	✅ Yes
`catalog.0.multi_audit_import`	Boolean	`true`, `false`	Enables import of multiple audit files.	❌ No
`catalog.0.file_name_pattern`	String	`Company.\\\\\\*`	Pattern to match multiple files.	✅ Yes
`catalog.0.include_subfolders`	Boolean	`true`, `false`	Specifies whether subfolders should be included.	✅ Yes
`catalog.0.fetch_only_incremental_files`	Boolean	`true`, `false`	Fetches only new files since the last import.	✅ Yes
`catalog.0.mergeFiles`	Boolean	`true`, `false`	Merges all matched files into a single file.	✅ Yes
`catalog.0.fetch_incremented_data`	Boolean	`true`, `false`	Fetches only incremented or updated data.	✅ Yes
`catalog.0.parseas`	String	`csv`	Format in which the file should be parsed.	✅ Yes
`catalog.0.path`	String	`/`	Folder path inside the S3 bucket.	✅ Yes
`feature_name`	String	`import`	Action being performed.	✅ Yes
`feature_type`	String	`0:amazons3`	Connection type used for import (Amazon S3).	✅ Yes

SAMPLE INPUT data for FTP:

{\"name\":\"SampleFTP.csv\",\"project_id\":\"55317000000092099\",\"replication_type\":\"1\",\"catalog\":{\"0\":{\"pattern\":\"SampleFTP.csv\",\"include_subfolders\":false,\"path\":\"/uploads\",\"name\":\"SampleFTP.csv\",\"fetch_only_incremental_files\":true,\"parseas\":\"csv\",\"mergeFiles\":false,\"fetch_incremented_data\":true}},\"feature_name\":\"import\",\"feature_type\":\"4:SSH\"}

Key	Type	Variables / Example Values	Description	Mandatory
`name`	String	`SampleFTP.csv`	Name of the file being imported.	✅ Yes
`project_id`	String	`55317000000092099`	Workspace ID from which the file will be imported.	✅ Yes
`replication_type`	String	`1`	Defines the type of replication used (for example, incremental or full load).	❌ No
`catalog`	Object	`{ \"0\": { ... } }`	Defines file fetch rules, parsing rules, and folder‑level configurations.	✅ Yes
`catalog.0.pattern`	String	`SampleFTP.csv`	Pattern or file name to match when fetching files.	✅ Yes
`catalog.0.include_subfolders`	Boolean	`false`	Specifies whether files inside subfolders should be included.	✅ Yes
`catalog.0.path`	String	`/uploads`	Folder path on the FTP/SFTP server from which the file is fetched.	✅ Yes
`catalog.0.name`	String	`SampleFTP.csv`	Name of the file to be imported.	✅ Yes
`catalog.0.fetch_only_incremental_files`	Boolean	`true`	Fetches only newly added or updated files.	✅ Yes
`catalog.0.parseas`	String	`csv`	Format in which the file should be parsed.	✅ Yes
`catalog.0.mergeFiles`	Boolean	`false`	Specifies whether multiple files should be merged into a single dataset.	✅ Yes
`catalog.0.fetch_incremented_data`	String	`import`	Indicates the action being performed (file import).	✅ Yes
`feature_name`	String	`import`	Feature/action being performed.	✅ Yes
`feature_type`	String	`4:SSH`	Connection type used for import (`4` indicates SFTP; `SSH` is the protocol).	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","connections",":{{connection_id}}","import"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"01584ee0-ed09-4a79-ad91-505e844942fc","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"3fd9bf28-9c24-4db4-85bb-e9330e94188b","description":{"content":"

The connection ID of the S3/FTP account from where you want to import your file. You can get it using the Connection API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{connection_id}}"}]}},"response":[{"id":"c5a8a7a4-6562-4912-9be2-949c4803b139","name":"Initiate import","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"SampleFTP.csv\",\"project_id\":\"55317000000092099\",\"replication_type\":\"1\",\"catalog\":{\"0\":{\"pattern\":\"SampleFTP.csv\",\"include_subfolders\":false,\"path\":\"/uploads\",\"name\":\"SampleFTP.csv\",\"fetch_only_incremental_files\":true,\"parseas\":\"csv\",\"mergeFiles\":false,\"fetch_incremented_data\":true}},\"feature_name\":\"import\",\"feature_type\":\"4:SSH\"}","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/connections/55317000000042951/import"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the Datasource audit id under the key \"datasourceaudit\" and rawdataset id under the key \"streams_info\".\n\n{\n \"datasourceaudit\": {\n \"id\": \"55317000000092017\",\n \"created_by\": {...}\n \"created_time\": \"1764767066751\",\n \"execution_status\": 0,\n \"streams_info\": \"{\\\"55317000000092011\\\":{\\\"size\\\":-1,\\\"catalog_stream_id\\\":\\\"0\\\"}}\",\n //////////////\n"}],"_postman_id":"85df666f-4309-4132-9322-85ab0fb57809"},{"name":"Create datasource","id":"9cff4b14-cdfc-4866-a250-e1fe02bb55dc","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"US Leads\",\"catalog\":{\"tapStreamId\":\"55317000000092011\"}}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasourceaudits/:{{datasourceaudit}}/datasource","description":"

This API is used to create the dataset with the file details you selected from S3/FTP.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample Input

{\"name\":\"US Leads\",\"catalog\":{\"tapStreamId\":\"55317000000092011\"}}

name = Name of the file to be imported.

tapstreamid = Rawdataset ID that can be retrieved from the Initiate Import API.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"c2f0a48b-d039-4db3-83e5-3375b5b38286","description":{"content":"

Datasourceaudit ID of your import. You can get it using the Initiate Import API - This API is used to start the import process from the selected S3/FTP connection using the connection ID.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{datasourceaudit}}"}]}},"response":[{"id":"1a72c18b-fc52-4211-bb84-91d81b1b93e3","name":"Create datasource","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"US Leads\",\"catalog\":{\"tapStreamId\":\"55317000000092011\"}}","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasourceaudits/55317000000092017/datasource"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the dataset id under the key \"dataset\".\n\n{\n \"dataset\": {\n \"id\": \"55317000000092043\",\n \"name\": \"US Leads\",\n \"description\": null,\n///////"}],"_postman_id":"9cff4b14-cdfc-4866-a250-e1fe02bb55dc"},{"name":"Create stage","id":"e3eecaa0-31b5-4400-9b29-50833bd1db2d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"datasets\":[\"55317000000092043\"]}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/stage","description":"

This API is used to add the imported file as a dataset so you can use it in your workspace.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample Input

{\"datasets\":[\"55317000000092043\"]}

This is the dataset ID that can be retrieved from the Create API.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"58ccb99b-c490-4188-b40f-f7b9275adef9","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"62ec23bc-2614-40fe-be77-35517b2f3245","name":"Create stage","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"datasets\":[\"55317000000092043\"]}","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/pipelines/55317000000092003/stage"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can find the dataset_id (stage_id)under the pipelinetaskdatasetmappers.\n\n{\n \"pipelinetaskdatasetmappers\": [\n {...},\n {\n \"dataset\": {\n \"id\": \"55317000000144503\",\n \"name\": \"Company\",\n \"description\": null,\n//////////////"}],"_postman_id":"e3eecaa0-31b5-4400-9b29-50833bd1db2d"},{"name":"Pipeline info","id":"6cd5fa94-a42d-4f7d-8029-b8317b1a6fda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/info","description":"

Use the Get Pipeline Info API to retrieve complete metadata about an existing pipeline. This API provides details of all stages and tasks configured within the pipeline, including source, transform, and destination stages.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"2ef61aaf-fae7-407f-9141-a5251def326f","description":{"content":"

Provide the ID of your pipeline. You can get it using the Get all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"3c667b46-e124-4998-af9d-8574d16c78c1","name":"Pipeline Info","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/pipelines/55317000000058553/info"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"1. Each object under pipelinetasks represents a stage and contains:\nid → This is your dataset_id (stage_id)\ntype → This identifies the stage type\n\nUse the type field to pick the correct stage depending on the operation:\n\nStage type identifier. \n5 - Extract(import)\n7 - Raw parse\n10 - transform\n15 - Stages extract\n20 - Load(export)\n\n2. From the response, you can identify the raw dataset ID located in the pipeline_task object under the key rawdataset, which is of type 7 since it corresponds to raw parsing.\n\n3. From the response, you can identify the stage ID (dataset ID) and sample ID located in the pipelinetask object under the key id, which belongs to the task whose type matches the stage you need (for example, type 10 for a Transform stage).\n\n4.From the response, you can identify the dataset export ID located in the pipelinetask object under the dataset_export key, which is of type 20 since it corresponds to an export. You can also find the pipeline task ID of the destination task you want to remove under the top-level id key.\n\n5. From the response, you can identify the Unique pipeline task ID of the Import node under the top-level id key which is of type 5 since it corresponds to import.\n\n{\n \"pipeline\": {\n.......\n\"pipelineaudit\": {...},\n\"pipelinetasks\": [\n{...},\n{\n {\n \"id\": \"55317000000058635\",\nThe pipeline task ID of the import node\n \"name\": \"119164519428633\",\n \"type\": 5,\n \"pipeline\": {\n \"id\": \"55317000000058559\",\n \"name\": \"My pipeline-2\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": false,\n \"depends_on_past\": false\n },\n{\n \"id\": \"55317000000092083\",\n \"name\": \"SampleFTP.csv\",\n \"type\": 7,\n \"rawdataset\": {\n \"id\": \"55317000000092353\",\n \"name\": \"SampleFTP.csv\",\n \"status\": 1,\n},\n{\n \"id\": \"55317000000144557\",\n \"name\": \"Company\",\n \"type\": 10,\n \n \"selected_sample\": {\n \"id\": \"55317000000144657\",\n \"dataset\": {\n \"id\": \"55317000000144645\",\n \"name\": \"Company_derived_dataset-1\",\n \"description\": null,\n \"status\": 1,\n \"is_ready\": false,\n \"is_pii_marked\": false,\n \"project\": {\n \"id\": \"55317000000022199\"\n },\n{\n \"id\": \"55317000000058837\",\n The pipeline task ID of the destination task that you want to remove\n \"name\": \"SampleFTP_1\",\n \"type\": 20,\n \"datasetexport\": {\n \"id\": \"55317000000058835\",\n The dataset export ID generated for your export activity. \n},//////\n }, /////////"}],"_postman_id":"6cd5fa94-a42d-4f7d-8029-b8317b1a6fda"},{"name":"Change datasource","id":"472add6d-3e05-4c9b-86e1-54b4a887ac32","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept-encoding":true,"connection":true,"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"SampleFTP\",\"catalog\":{\"tapStreamId\":\"55317000000058729\"},\"datasourceaudit_id\":\"55317000000058735\"}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/rawdatasets/:{{rawdataset_id}}/change_datasource","description":"

Use the Change Datasource API to replace the existing datasource of a pipeline with a new one. This API allows you to update the source configuration without creating a new pipeline from scratch.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"name\":\"SampleFTP\",\"catalog\":{\"tapStreamId\":\"55317000000058729\"},\"datasourceaudit_id\":\"55317000000058735\"}

name = Name of the file to be imported.

tapstreamid = rawdataset ID that can be retrieved from the Initiate Import API.

datasourceaudit_id = Datasource audit ID that can be retrieved from the Initiate import API.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"24243a63-535d-49ff-9020-1d295520290e","description":{"content":"

Provide the raw dataset ID of existing datasource in your pipeline. You can get it using the Get pipelines info API.\nSteps to get the rawdataset_id:\n1.In the API response, locate the top‑level pipeline object.\n2. Navigate to the pipelinetasks array within the pipeline object.\n3. Iterate through each task in the pipelinetasks array.\n4.Identify the task that contains the rawdataset object.\n5.Navigate through the nested object: rawdataset → id.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{rawdataset_id}}"}]}},"response":[{"id":"ef098a95-8504-43d8-aa5b-2900db924a65","name":"Change datasource","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"name\":\"SampleFTP\",\"catalog\":{\"tapStreamId\":\"55317000000058729\"},\"datasourceaudit_id\":\"55317000000058735\"}","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1portals/zylkerwl/rawdatasets/55213467883637337/change_datasource"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"datasourceaudit\": {\n \"id\": \"55317000000092427\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110790782\",\n//////////////"}],"_postman_id":"472add6d-3e05-4c9b-86e1-54b4a887ac32"},{"name":"Derive stage","id":"354fae63-9717-4780-ab7a-6816de6ca0e0","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept-encoding":true,"connection":true,"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"dataset\":{\"name\":\"Dial code-1_derived_dataset\"}}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasets/:{{dataset_id}}/derive","description":"

Creates a new derived dataset from a given stage.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"dataset\":{\"name\":\"Dial code-1_derived_dataset\"}}

name = Name of the stage to be derived.

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"c7424a5a-2108-475a-80f4-d526d01a676c","description":{"content":"

Provide the dataset ID (stage) which you want to derive. You can get it from the response of the Create Stage API or using Get pipelines info API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{dataset_id}}"}]}},"response":[{"id":"eff7dd68-8105-47e1-8cfa-9ef23e77026f","name":"Derive stage","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"dataset\":{\"name\":\"Dial code-1_derived_dataset\"}}","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1portals/zylkerwl/datasets/55317000000144047/derive"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"datasourceaudit\": {\n \"id\": \"55317000000092427\",\n \"created_by\": {\n \"id\": \"55317000000022189\",\n \"zuid\": \"10110790782\",\n//////////////"}],"_postman_id":"354fae63-9717-4780-ab7a-6816de6ca0e0"},{"name":"Add cloud destination (S3/FTP)","id":"46b665dc-018e-4efc-b761-efe09442b733","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept-encoding":true,"connection":true,"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"export_now\":false,\"name\":\"ftp\",\"connection_id\":\"55317000000058565\",\"catalog\":{\"EXPORTTYPE\":\"FILE\",\"FILEFORMAT\":\"CSV\",\"fileName\":\"SampleFTP_1\",\"COMPRESSED\":false,\"OUTFILE\":\"SampleFTP_1\",\"ROW_SEPARATOR\":\"UNIX\",\"QUALIFIER\":\"double\",\"CHARSET\":\"UTF-8\",\"DELIMITER\":\",\",\"type\":\"new_file_with_date\",\"overrideNameExist\":false,\"remote_folder_path\":\"/uploads\",\"INCLUDED_PII_COLS\":[],\"INCLUDE_TYPE\":\"all\"}}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasets/:{{dataset_id}}/cloud_destination","description":"

Use this API to add Amazon S3 or FTP as a destination for your pipeline. It exports data from the specified dataset stage (raw or transformed) to the configured S3 bucket or FTP location.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input for FTP:

{\"export_now\":false,\"name\":\"ftp\",\"connection_id\":\"55317000000058565\",\"catalog\":{\"EXPORTTYPE\":\"FILE\",\"FILEFORMAT\":\"CSV\",\"fileName\":\"SampleFTP_1\",\"COMPRESSED\":false,\"OUTFILE\":\"SampleFTP_1\",\"ROW_SEPARATOR\":\"UNIX\",\"QUALIFIER\":\"double\",\"CHARSET\":\"UTF-8\",\"DELIMITER\":\",\",\"type\":\"new_file_with_date\",\"overrideNameExist\":false,\"remote_folder_path\":\"/uploads\",\"INCLUDED_PII_COLS\":[],\"INCLUDE_TYPE\":\"all\"}}

Key	Type	Variables / Example Values	Description	Mandatory
`export_now`	Boolean	`true`, `false` (Example: `false`)	Indicates whether the export should be triggered immediately.	✅ Yes
`name`	String	`\"ftp\"`	Name of the export task. Always `ftp` for FTP exports.	✅ Yes
`connection_id`	String	`\"55317000000058565\"`	ID of the FTP connection to be used for export.	✅ Yes
`catalog.EXPORTTYPE`	String	`\"FILE\"`	Export type. Always `FILE` for FTP exports.	✅ Yes
`catalog.FILEFORMAT`	String	`\"CSV\"`, `\"TSV\"`	File format to be generated.	✅ Yes
`catalog.fileName`	String	`\"SampleFTP_1\"`	Base file name used before adding timestamp or extension.	✅ Yes
`catalog.COMPRESSED`	Boolean	`true`, `false`	Specifies whether the exported file should be compressed.	❌ No
`catalog.OUTFILE`	String	`\"SampleFTP_1\"`	Output file name without extension.	✅ Yes
`catalog.ROW_SEPARATOR`	String	`\"UNIX\"`, `\"WINDOWS\"`	Row separator style for the exported file.	✅ Yes
`catalog.QUALIFIER`	String	`\"double\"`, `\"single\"`	Text qualifier type used in the file.	✅ Yes
`catalog.CHARSET`	String	`\"UTF-8\"`	Character encoding of the exported file.	✅ Yes
`catalog.DELIMITER`	String	`\",\"`, `\"\\t\"`	Field delimiter for CSV/TSV files.	✅ Yes
`catalog.type`	String	`\"new_file_with_date\"`, `\"overwrite\"`	File writing mode on the FTP server.	✅ Yes
`catalog.overrideNameExist`	Boolean	`true`, `false`	Indicates whether an existing file should be overwritten.	✅ Yes
`catalog.remote_folder_path`	String	`\"/uploads\"`	FTP folder path where the exported file will be uploaded.	✅ Yes
`catalog.INCLUDED_PII_COLS`	Array	`[]` or list of column names	List of PII columns to include in the export.	❌ No
`catalog.INCLUDE_TYPE`	String	`\"all\"`, `\"pii_only\"`, `\"non_pii_only\"`	Specifies which type of columns should be exported.	✅ Yes

Sample input for S3:

{\"export_now\":false,\"name\":\"amazons3\",\"connection_id\":\"55317000000042951\",\"catalog\":{\"EXPORTTYPE\":\"FILE\",\"FILEFORMAT\":\"CSV\",\"COMPRESSED\":false,\"OUTFILE\":\"Company\",\"ROW_SEPARATOR\":\"UNIX\",\"QUALIFIER\":\"double\",\"CHARSET\":\"UTF-8\",\"DELIMITER\":\",\",\"type\":\"new_file_with_date\",\"filename\":\"Company\",\"bucket\":\"leads2025\",\"path\":\"/\",\"INCLUDED_PII_COLS\":[],\"INCLUDE_TYPE\":\"all\"}}

Key	Type	Variables / Example Values	Description	Mandatory
`export_now`	Boolean	`true`, `false` (Example: `false`)	Indicates whether the export should be triggered immediately.	✅ Yes
`name`	String	`\"amazons3\"`	Name of the export connector.	✅ Yes
`connection_id`	String	`\"55317000000042951\"`	Connection ID of the Amazon S3 connector.	✅ Yes
`catalog.EXPORTTYPE`	String	`\"FILE\"`	Type of export.	✅ Yes
`catalog.FILEFORMAT`	String	`\"CSV\"`, `\"JSON\"`	File format of the exported data.	✅ Yes
`catalog.COMPRESSED`	Boolean	`true`, `false`	Specifies whether the exported file should be compressed.	❌ No
`catalog.OUTFILE`	String	`\"Company\"`	Output file name without extension.	✅ Yes
`catalog.ROW_SEPARATOR`	String	`\"UNIX\"`, `\"Windows\"`	Row separator used in the file.	❌ No
`catalog.QUALIFIER`	String	`\"double\"`, `\"single\"`	Text qualifier for the file.	❌ No
`catalog.CHARSET`	String	`\"UTF-8\"`, `\"UTF-16\"`	Character encoding of the file.	❌ No
`catalog.DELIMITER`	String	`\",\"`, `\"\\t\"`, `\";\"`	Column delimiter.	❌ No
`catalog.type`	String	`\"new_file_with_date\"`	Export file naming/type setting.	✅ Yes
`catalog.filename`	String	`\"Company\"`	Name of the file to be stored in Amazon S3.	✅ Yes
`catalog.bucket`	String	`\"leads2025\"`	Amazon S3 bucket name.	✅ Yes
`catalog.path`	String	`\"/\"`	Folder path inside the S3 bucket.	✅ Yes
`catalog.INCLUDED_PII_COLS`	Array	`[]`, `[\"col1\",\"col2\"]`	List of PII columns to include.	❌ No
`catalog.INCLUDE_TYPE`	String	`\"all\"`, `\"pii_columns\"`	Defines which columns should be exported.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","datasets",":{{dataset_id}}","cloud_destination"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"91ec0d8a-1e17-49ea-9ea8-a66ba2014158","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"1b3b1648-c136-430a-910b-fa04b9ee9025","description":{"content":"

Provide the dataset’s ID (stage) from where the destination will be added. You can get it using the Get pipelines info API or from the response of the Create Stage API.

Steps to get dataset_id:

In the Pipeline Info response, locate the pipeline task within the pipelinetasks array
Identify Transform task
Navigate through the nested object based on the task type:
For Transform tasks: dataset → id

\n","type":"text/plain"},"type":"any","value":"string","key":"{{dataset_id}}"}]}},"response":[{"id":"0b871711-d7e1-4d3d-aff9-79e22ec3cf4e","name":"Add cloud destination (S3/FTP)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"export_now\":false,\"name\":\"ftp\",\"connection_id\":\"55317000000058565\",\"catalog\":{\"EXPORTTYPE\":\"FILE\",\"FILEFORMAT\":\"CSV\",\"fileName\":\"SampleFTP_1\",\"COMPRESSED\":false,\"OUTFILE\":\"SampleFTP_1\",\"ROW_SEPARATOR\":\"UNIX\",\"QUALIFIER\":\"double\",\"CHARSET\":\"UTF-8\",\"DELIMITER\":\",\",\"type\":\"new_file_with_date\",\"overrideNameExist\":false,\"remote_folder_path\":\"/uploads\",\"INCLUDED_PII_COLS\":[],\"INCLUDE_TYPE\":\"all\"}}","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasets/55317000000092043/cloud_destination"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"dataset\": {\n \"id\": \"55317000000101081\",\n \"name\": \"US Leads_derived_dataset\",\n \"description\": null,\n \"created_by\": {\n///////////"}],"_postman_id":"46b665dc-018e-4efc-b761-efe09442b733"},{"name":"Apply rules","id":"38e7e86c-4f2c-488f-bc7f-ce68ecb45d2d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept-encoding":true,"connection":true,"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasetsamples/:{{sample_id}}/apply","description":"

The Apply API is used to execute and manage transformation rules for a dataset sample. Using the same endpoint, you can apply transforms, re‑order rules, enable or disable rules, remove rules, and edit existing rules by providing the required input.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

i) Transforms

All transforms follow the same request URL, request format, and response structure. The only variation is in the input parameters, which are provided below for each transform.

1. Change case

The Change Case API is used to modify the text case of one or more columns in a dataset.

Sample input:

{\"rule\":{\"name\":\"changecase\",\"params\":{\"cols\":[\"Region\"],\"type\":\"upper\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	–	Rule block that contains the transform instruction.	✅ Yes
`rule.name`	String	`\"changecase\"`	Specifies the transform operation to apply.	✅ Yes
`rule.params`	Object	–	Contains parameters required for the `changecase` transform.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"Region\"]`	List of column names on which the case change is applied.	✅ Yes
`rule.params.type`	String	`\"upper\"`, `\"lower\"`, `\"title\"`	Defines how the text case should be changed.	✅ Yes
`rule.meta`	Object	–	Metadata related to the transform rule.	❌ No
`rule.meta.optionType`	String	`\"text_case\"`	Specifies the transform category.	❌ No

2. Add prefix or suffix

This API allows you to add prefixes and suffixes to your data.

Sample input

{\"rule\":{\"name\":\"Append\",\"params\":{\"cols\":[\"id\"],\"prefix\":\"ID_\",\"suffix\":\"_END\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the append transform instruction.	✅ Yes
`rule.name`	String	`\"Append\"`	Specifies the append transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for the append operation.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"id\"]`	Columns on which the prefix and/or suffix will be appended.	✅ Yes
`rule.params.prefix`	String	`\"ID_\"`	Value to be appended at the beginning of the column value.	❌ No
`rule.params.suffix`	String	`\"_END\"`	Value to be appended at the end of the column value.	❌ No

3. Change data type

This API identifies the data type of each column in your data.

Sample input

{\"rule\":{\"name\":\"SetDataType\",\"params\":{\"cols\":[\"date_column\"],\"type\":\"date\",\"dataType\":{\"name\":\"date\",\"baseType\":\"date\",\"format\":{\"format\":\"yyyy-MM-dd\"}}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the set data type transform instruction.	✅ Yes
`rule.name`	String	`\"SetDataType\"`	Specifies the set data type transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for setting the data type.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"date_column\"]`	Columns whose data type needs to be updated.	✅ Yes
`rule.params.type`	String	`\"date\"`	Logical data type to be applied to the specified columns.	❌ No
`rule.params.dataType`	Object (DataType)	`{\"name\":\"date\",\"baseType\":\"date\",\"format\":{\"format\":\"yyyy-MM-dd\"}}`	Defines the detailed data type configuration for the column.	❌ No
`rule.params.dataType.name`	String	`\"date\"`	Name of the target data type.	❌ No
`rule.params.dataType.baseType`	String	`\"date\"`	Base data type category.	❌ No
`rule.params.dataType.format`	Object	`{\"format\":\"yyyy-MM-dd\"}`	Specifies formatting rules for the data type.	❌ No
`rule.params.dataType.format.format`	String	`\"yyyy-MM-dd\"`	Date format used to parse and display values.	❌ No

4. Change number format

This API standardizes numeric values by applying region-specific number formatting rules.

Sample input

{\"rule\":{\"name\":\"NumberFormat\",\"params\":{\"cols\":[\"amount\"],\"ts\":\",\",\"ds\":\".\",\"lang\":\"en\",\"country\":\"US\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the number format transform instruction.	✅ Yes
`rule.name`	String	`\"NumberFormat\"`	Specifies the number format transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for formatting numeric values.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"amount\"]`	Columns whose number format needs to be updated.	✅ Yes
`rule.params.ts`	String	`\",\"`	Thousand separator used in the number format.	❌ No
`rule.params.ds`	String	`\".\"`	Decimal separator used in the number format.	❌ No
`rule.params.lang`	String	`\"en\"`	Language code used for number formatting.	❌ No
`rule.params.country`	String	`\"US\"`	Country code used for locale-specific formatting.	❌ No

5. Change date format

This API allows you to change the date values by converting them into a specified date format.

Sample Input

{\"rule\":{\"name\":\"DateFormat\",\"params\":{\"cols\":[\"date_col\"],\"format\":\"yyyy-MM-dd\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the date format transform instruction.	✅ Yes
`rule.name`	String	`\"DateFormat\"`	Specifies the date format transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for formatting date values.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"date_col\"]`	Columns whose date format needs to be updated.	✅ Yes
`rule.params.format`	String	`\"yyyy-MM-dd\"`	Target date format to be applied.	✅ Yes

6. Change time format

This API converts the values of time columns into a specified time or date‑time format.

Sample input

{\"rule\":{\"name\":\"DateFormat\",\"params\":{\"cols\":[\"date_col\"],\"format\":\"HH:mm:ss\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the date/time format transform instruction.	✅ Yes
`rule.name`	String	`\"DateFormat\"`	Specifies the date/time format transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for date/time formatting.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"date_col\"]`	Columns whose date/time values need to be reformatted.	✅ Yes
`rule.params.format`	String	`\"HH:mm:ss\"`	Target time format to be applied to the column values.	✅ Yes

7. Change duration format

This API standardizes the format of duration values in a column.

Sample Input

{\"rule\":{\"name\":\"DurationFormat\",\"params\":{\"cols\":[\"duration_col\"],\"format\":\"HH:mm:ss\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the duration format transform instruction.	✅ Yes
`rule.name`	String	`\"DurationFormat\"`	Specifies the duration format transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for formatting duration values.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"duration_col\"]`	Columns whose duration format needs to be updated.	✅ Yes
`rule.params.format`	String	`\"HH:mm:ss\"`	Target duration format to be applied.	✅ Yes

8. Cluster and merge transform

This API helps you performs fuzzy matching to standardize multiple variations of the same data.

Sample input

{\"rule\":{\"name\":\"cluster\",\"params\":{\"cols\":[\"Product Category\"],\"type\":\"nGram\",\"nGram\":2,\"limit\":50}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the transform instruction.	✅ Yes
`rule.name`	String	`\"cluster\"`	Specifies the cluster transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for clustering.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"Product Category\"]`	Columns on which clustering is applied.	✅ Yes
`rule.params.type`	String	`\"nGram\"`, `\"cosine\"`, `\"jaccard\"`	Clustering method/type.	✅ Yes
`rule.params.nGram`	Number	`2`, `3`	nGram value for nGram-based clustering.	❌ No
`rule.params.limit`	Number	`50`	Maximum number of clusters to create.	❌ No
`rule.meta`	Object	`{...}`	Metadata related to the transform rule.	❌ No
`rule.meta.optionType`	String	`\"text_cluster\"`	Specifies the transform category.	❌ No

9. Convert units

This API allows you to convert values from one unit to another in the selected column.

Sample input

{\"rule\":{\"name\":\"convert\",\"params\":{\"cols\":[\"length\"],\"into\":\"m\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the transform instruction.	✅ Yes
`rule.name`	String	`\"convert\"`	Specifies the unit conversion transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for unit conversion.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"length\"]`	Columns on which the unit conversion is applied.	✅ Yes
`rule.params.into`	String	`\"m\"`, `\"cm\"`, `\"km\"`, `\"ft\"`, `\"inch\"`, `\"kg\"`, `\"lb\"`	Target unit to convert the column values into.	✅ Yes
`rule.meta`	Object	`{...}`	Metadata related to the transform rule.	❌ No
`rule.meta.optionType`	String	`\"unit_convert\"`	Specifies the transform category.	❌ No

10. Count

This API counts the occurrences of the given text or pattern or regex.

Sample input

{\"rule\":{\"name\":\"CountText\",\"params\":{\"colList\":[{\"col\":\"text\",\"as\":\"comma_count\"}],\"delimiter\":{\"on\": \",\"},\"iCase\":false}}}

The table below details the input parameters for all available Count options, including Count text, Count pattern and Count regex. Click here to know more.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the count transform instruction.	✅ Yes
`rule.name`	String	`\"CountText\"`, `\"CountRegEx\"`	Specifies the count operation type (Count text or Count pattern).	✅ Yes
`rule.params`	Object	`{...}`	Contains parameters required for the count operation.	✅ Yes
`rule.params.colList`	Array	`[{\"col\":\"text\",\"as\":\"word_count\"}]`	Source column and output column name for storing the count result.	✅ Yes
`rule.params.delimiter`	Object	`{\"on\": \",\"}`, `{\"on\":\"{digit}\"}`	Defines the delimiter or structured pattern used for counting occurrences.	⚠️ Conditional
`rule.params.delimiter.on`	String	`\",\"`, `\"{digit}\"`	Character, token, or pattern on which occurrences are counted.	⚠️ Conditional
`rule.params.regEx`	String	`\"\\\\b\\\\w+\\\\b\"`	Regular expression used to match and count occurrences.	⚠️ Conditional
`rule.params.iCase`	Boolean	`false`	Enables case‑insensitive counting.	❌ No

Note: Both Count Text and Count Pattern use the CountText rule.name and are differentiated by the value of rule.params.delimiter.on.

Literal characters indicate text‑based counting, while predefined tokens (for example, {digit}) indicate pattern‑based counting.

11. Create buckets - Date

This API groups date values into buckets based on week names such as weekends.

Sample input

{\"rule\":{\"name\":\"bucket\",\"params\":{\"colList\":[{\"col\":\"Created Time\",\"as\":\"Created Time_bucket\"}],\"type\":\"wn\",\"buckets\":[{\"criteria\":[{\"values\":[\"Saturday\",\"Sunday\"],\"type\":\"in\",\"all\":false}],\"label\":null}],\"label\":\"\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the bucket transform instruction.	✅ Yes
`rule.name`	String	`\"bucket\"`	Specifies the bucket transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for bucketing.	✅ Yes
`rule.params.colList`	Array	`[{\"col\":\"Created Time\",\"as\":\"Created Time_bucket\"}]`	Source date column and target bucket column.	✅ Yes
`rule.params.type`	String	`\"wn\"`	Week‑name based bucketing type.	✅ Yes
`rule.params.label`	String	`\"\"`	Default label for unmatched values.	❌ No
`rule.params.n`	Integer	`null`	Number of auto‑generated buckets.	❌ No
`rule.params.buckets`	Array	See example above	Defines custom date‑based bucket rules.	❌ No

12. Create buckets - Number

This API groups numeric values into manually defined buckets using given criteria

Sample input

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the bucket transform instruction.	✅ Yes
`rule.name`	String	`\"bucket\"`	Specifies the bucket transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for bucketing.	✅ Yes
`rule.params.colList`	Array	`[{\"col\":\"id\",\"as\":\"id_bucket\"}]`	Source numeric column and target bucket column.	✅ Yes
`rule.params.type`	String	`\"manual\"`	Manual bucketing type.	✅ Yes
`rule.params.buckets`	Array	See example above	Defines numeric bucket rules.	❌ No
`rule.params.label`	String	`\"N/A\"`	Default label for values outside defined buckets.	❌ No

13. Create buckets - Text

This API groups text values into predefined buckets based on matching criteria and assigns bucket labels.

Sample input

{\"rule\":{\"name\":\"bucket\",\"params\":{\"colList\":[{\"col\":\"Brand\",\"as\":\"Brand_bucket\"}],\"type\":\"manual\",\"buckets\":[{\"criteria\":[{\"values\":[\"o\"],\"type\":\"in\",\"all\":false}],\"label\":\"b\",\"all\":true}],\"label\":\"N/A\"}}}

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the bucket transform instruction.	✅ Yes
`rule.name`	String	`\"bucket\"`	Specifies the bucket transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for bucketing data.	✅ Yes
`rule.params.colList`	Array	`[{\"col\":\"Brand\",\"as\":\"Brand_bucket\"}]`	Source column and target bucket column.	✅ Yes
`rule.params.colList.col`	String	`\"Brand\"`	Column whose values are evaluated for bucketing.	✅ Yes
`rule.params.colList.as`	String	`\"Brand_bucket\"`	Name of the newly created bucket column.	✅ Yes
`rule.params.type`	String	`\"manual\"`	Specifies manual bucket definition.	✅ Yes
`rule.params.buckets`	Array	See example	Defines bucket conditions and labels.	✅ Yes
`rule.params.buckets.criteria`	Array	`[{\"type\":\"in\",\"values\":[\"o\"],\"all\":false}]`	Conditions used to match values for a bucket.	✅ Yes
`rule.params.buckets.criteria.type`	String	`\"in\"`	Matching logic for bucket criteria.	✅ Yes
`rule.params.buckets.criteria.values`	Array of Strings	`[\"o\"]`	Values used for text matching.	✅ Yes
`rule.params.buckets.criteria.all`	Boolean	`false`	Indicates whether all values must match.	❌ No
`rule.params.buckets.label`	String	`\"b\"`	Label assigned when criteria match.	❌ No
`rule.params.buckets.all`	Boolean	`true`	Applies bucket rule to all matching values.	❌ No
`rule.params.label`	String	`\"N/A\"`	Default label for values that do not match any bucket.	❌ No

14. Duplicate column

This API creates a duplicate of an existing column and stores it as a new column.

Sample input

{\"rule\":{\"name\":\"duplicatecolumn\",\"params\":{\"colList\":[{\"col\":\"original\",\"as\":\"copy_of_original\"}]}}}

Duplicate Column Transform – Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the duplicate column transform instruction.	✅ Yes
`rule.name`	String	`\"duplicatecolumn\"`	Specifies the duplicate column transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for duplicating columns.	✅ Yes
`rule.params.colList`	Array	`[{\"col\":\"original\",\"as\":\"copy_of_original\"}]`	Defines the source column to duplicate and the target column name.	✅ Yes

15. Fill empty cells

This API helps you fill empty cells in a column.

Sample input

{\"rule\":{\"name\":\"fill\",\"params\":{\"cols\":[\"Sales\",\"Cost\"],\"type\":\"expr\",\"formula\":\"sum(`Sales`)\",\"orderBy\":[{\"col\":\"Name\"}]}}}

**
Note:** The table below details the input parameters for all available Fill Empty Cells options, including Previous cell value, Next cell value, Most frequent value, Average value for the column, Custom values, and Formula. Click here to know more.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the fill transform instruction.	✅ Yes
`rule.name`	String	`\"Fill\"`	Specifies the fill empty cells transform.	✅ Yes
`rule.params`	Object	`{...}`	Contains parameters required for filling empty cells.	✅ Yes
`rule.params.cols`	Array	`[\"column1\"]`, `[\"Activities Involved\"]`	Columns in which empty values need to be filled.	✅ Yes
`rule.params.type`	String (FillType)	`constant`, `precede`, `succeed`, `mode`, `static`, `expr`	Determines how empty values are filled.	✅ Yes
`rule.params.formula`	String	`\"N/A\"`, `\"custom\"`, `\"concat_ws(\\\\\\\\\\\\\\\\\\*)\"`	Value or expression used to fill empty cells.	⚠️ Conditional*
`rule.params.orderBy`	Array	`[{\"col\":\"__zsid\",\"asc\":true}]`	Defines row order for previous/next value filling.	⚠️ Conditional*

* Conditional Requirements:

formula is required only when type is constant, static, or expr.
\n
orderBy is required only when type is precede or succeed.
\n

Fill Type Options

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Logic
`constant`	Fills empty cells with a fixed or custom value.
`precede`	Fills using the previous non‑empty value.
`succeed`	Fills using the next non‑empty value.
`mode`	Fills using the most frequent value.
`static`	Fills with a custom literal value.
`expr`	Fills using a formula or expression.

16. Extract text

Extract the value that matches with the given text.

Sample input

{\"rule\":{\"name\":\"ExtractText\",\"params\":{\"colList\":[{\"col\":\"text\",\"as\":\"extracted\"}],\"into\":\"array\",\"delimiter\":{\"after\":\"START:\",\"before\":\":END\"},\"iCase\":false,\"limit\":null}}}

Note: The table below details the input parameters for all available Extract Text options, including: Start and End Index, Start Index and Length, Matching Text or Pattern, Numbers, Regex, First N Characters, Last N Characters, Valid Values, Invalid Values, Email, and URL. Click here to know more.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example	Description	Mandatory	Applicable For
`rule`	Object	`{...}`	The rule block that contains the transform instruction.	✅ Yes	All extract types
`rule.name`	String	`\"ExtractUrl\"`, `\"ExtractRegEx\"`, `\"ExtractPositions\"`, `\"ExtractText\"`, `\"ExtractOn\"`, `\"ExtractQuality\"`, `\"ExtractEmail\"`, `\"extracttext\"`	Specifies the type of extract transform operation.	✅ Yes	All extract types
`rule.params`	Object	`{...}`	Contains the parameters required for the extract transform.	✅ Yes	All extract types
`rule.params.colList`	Array of Objects	`[{\"col\":\"text\",\"as\":\"extracted\"}]`	List of columns and output names.	✅ Yes	All extract types
`rule.params.colList[].col`	String	`\"url\"`, `\"text\"`, `\"email\"`, `\"sales\"`	Source column to extract from.	✅ Yes	All extract types
`rule.params.colList[].as`	String	`\"url_parts\"`, `\"numbers\"`, `\"extracted\"`, `\"sales_extract\"`	Output column name after extraction.	✅ Yes	All extract types
`rule.params.into`	String	`\"columns\"`, `\"array\"`	Output type: separate columns or array/list.	✅ Yes	All extract types
`rule.params.types`	Array[String]	`[\"protocol\",\"domain\",\"path\"]`, `[\"valid\",\"invalid\"]`	Defines which components to extract.	⚠️ Conditional	ExtractUrl, ExtractQuality, ExtractEmail
`rule.params.regEx`	String	`\"\\\\d+\"`	Regular expression for extraction.	⚠️ Conditional	ExtractRegEx
`rule.params.iCase`	Boolean	`true`, `false`	Case-insensitive matching.	❌ Optional	Regex, Text, On, Pattern
`rule.params.limit`	Number	`1`, `2`, `null`	Maximum number of matches per cell.	❌ Optional	Regex, Text, Pattern, Number
`rule.params.at`	Object	`{\"from\":0,\"len\":3}`, `{\"len\":10,\"last\":true}`	Position info for extracting text.	⚠️ Conditional	ExtractPositions, First N, Last N
`rule.params.at.from`	Number	`0`, `1`	Start index: position from which extraction begins.	❌ Optional	First N, Start & Length
`rule.params.at.to`	Number	`null`	End index for extraction.	❌ Optional	Start & Length
`rule.params.at.len`	Number	`3`, `10`	Number of characters to extract.	❌ Optional	Start & Length, First N, Last N
`rule.params.at.last`	Boolean	`true`, `false`	Extract from the end if true.	❌ Optional	Last N
`rule.params.delimiter`	Object	`{\"after\":\"START:\",\"before\":\":END\"}`, `{\"on\":\"{number}\"}`	Defines text-based delimiter or pattern.	⚠️ Conditional	ExtractText, Number, Pattern
`rule.params.delimiter.type`	String	`\"text\"`, `\"pattern\"`, `\"regex\"`	Type of extraction matching.	⚠️ Conditional	ExtractText, Pattern, Regex
`rule.params.delimiter.from`	String	`\" \"`	Start boundary for extraction.	❌ Optional	ExtractText
`rule.params.delimiter.to`	String	`\".\"`	End boundary for extraction.	❌ Optional	ExtractText
`rule.params.type`	String	`\"text\"`	Type of extract for keyword-based extraction.	⚠️ Conditional	ExtractOn
`rule.params.on`	Array[String]	`[\"important\",\"urgent\"]`	List of keywords to extract.	⚠️ Conditional	ExtractOn
`rule.meta`	Object	`{...}`	Metadata related to the transform rule.	❌ No	All
`rule.meta.optionType`	String	`\"text_extract\"`	Specifies the transform category.	❌ No	All

17. Extract from dates

This API extracts specific components (such as year, month, and day) from a date column.

Sample input

{\"rule\":{\"name\":\"ExtractDate\",\"params\":{\"colList\":[{\"col\":\"date\",\"as\":\"date_parts\"}],\"into\":\"columns\",\"types\":[\"year\",\"month\",\"day\"]}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the extract date transform instruction.	✅ Yes
`rule.name`	String	`\"ExtractDate\"`	Specifies the extract date transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for extracting date components.	✅ Yes
`rule.params.colList`	Array of RuleColumnInfo	`[{\"col\":\"date\",\"as\":\"date_parts\"}]`	Source date column and base name for extracted columns.	✅ Yes
`rule.params.colList.col`	String	`\"date\"`	Column from which date parts are extracted.	✅ Yes
`rule.params.colList.as`	String	`\"date_parts\"`	Base name used for generated date part columns.	✅ Yes
`rule.params.into`	SplitType	`\"columns\"`	Specifies that extracted values are written into separate columns.	✅ Yes
`rule.params.types`	Array of Strings	`[\"year\",\"month\",\"day\"]`	Date components to be extracted from the source column.	✅ Yes

18. Extract time

This API extracts specific time‑related components from a date time column and outputs them as separate columns.

Sample input

{\"rule\":{\"name\":\"extractdate\",\"params\":{\"colList\":[{\"col\":\"Created Time\",\"as\":\"Created Time_extract\"}],\"into\":\"columns\",\"types\":[\"year\",\"myear\"]}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
`rule`	Object	`{...}`	The rule block that contains the extract time transform instruction.	✅ Yes
`rule.name`	String	`\"extractdate\"`	Specifies the extract time/date transform operation.	✅ Yes
`rule.params`	Object	`{...}`	Contains the parameters required for extracting time components.	✅ Yes
`rule.params.colList`	Array of RuleColumnInfo	`[{\"col\":\"Created Time\",\"as\":\"Created Time_extract\"}]`	Source datetime column and base name for extracted columns.	✅ Yes
`rule.params.colList.col`	String	`\"Created Time\"`	Column from which time components are extracted.	✅ Yes
`rule.params.colList.as`	String	`\"Created Time_extract\"`	Base name used for generated time part columns.	✅ Yes
`rule.params.into`	SplitType	`\"columns\"`	Specifies that extracted values are written into separate columns.	✅ Yes
`rule.params.types`	Array of Strings	`[\"year\",\"myear\"]`	Time/date components to be extracted from the source column.	✅ Yes

19. Extract from list and map

This API extracts data from the list and map columns.

Extract from list

Sample input

{\"rule\":{\"name\":\"AutoFlatten\",\"params\":{\"col\":\"array_column\",\"type\":\"rows\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
`rule`	Object	`{...}`	Rule block containing the extract instruction.	✅ Yes
`rule.name`	String	`\"AutoFlatten\"`	Specifies the auto‑flatten operation.	✅ Yes
`rule.params`	Object	`{...}`	Parameters for auto‑flattening.	✅ Yes
`rule.params.col`	String	`\"array_column\"`	Column containing array data to be flattened.	✅ Yes
`rule.params.type`	String	`\"rows\"`	Defines how flattened data is output (row‑wise).	❌ No (Default: `rows`)

Extract from map

Sample input

{\"rule\":{\"name\":\"AutoUnnest\",\"params\":{\"col\":\"json_column\",\"keys\":[[\"key1\"],[\"key2\",\"nested\"]],\"pluck\":false,\"lineage\":false,\"dropSrc\":false}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
`rule`	Object	`{...}`	Rule block containing the extract instruction.	✅ Yes
`rule.name`	String	`\"AutoUnnest\"`	Specifies the auto‑unnest operation.	✅ Yes
`rule.params`	Object	`{...}`	Parameters for JSON/map extraction.	✅ Yes
`rule.params.col`	String	`\"json_column\"`	Column containing JSON/map data.	✅ Yes
`rule.params.keys`	Array of Array	`[[ \"key1\" ], [ \"key2\", \"nested\" ]]`	Key paths (including nested keys) to extract.	✅ Yes
`rule.params.pluck`	Boolean	`false`	Extract only values without retaining key names.	❌ No
`rule.params.lineage`	Boolean	`false`	Preserve parent‑child key hierarchy.	❌ No
`rule.params.dropSrc`	Boolean	`false`	Drop the source column after extraction.	❌ No

20. Keyword extraction

This API extracts important keywords and key phrases from text data using a machine-learning model.

Sample input

{\"rule\":{\"name\":\"mlderive\",\"params\":{\"col\":\"id_bucket\",\"as\":\"New\",\"type\":\"keyword_extraction\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the ML derive instruction	✅ Yes
rule.name	String	`\"mlderive\"`	Specifies the ML derive transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for ML derivation	✅ Yes
rule.params.col	String	`\"id_bucket\"`	Source column containing text for keyword extraction	✅ Yes
rule.params.as	String	`\"New\"`	Target column to store extracted keywords	✅ Yes
rule.params.type	String (MLType)	`\"keyword_extraction\"`	Specifies keyword extraction as the ML operation	✅ Yes
rule.params.options	Map[String, String]	`null`	Additional configuration options for keyword extraction (if supported)	❌ No

21. Language detection

This API detects the language of text data using a machine‑learning model.

Sample input

{\"rule\":{\"name\":\"mlderive\",\"params\":{\"col\":\"Item ID\",\"as\":\"New column\",\"type\":\"lang_predict\",\"options\":{\"lang_type\":\"name\"}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the ML derive instruction.	✅ Yes
rule.name	String	`\"mlderive\"`	Specifies the ML derive transform operation.	✅ Yes
rule.params	Object	–	Contains the parameters required for ML derivation.	✅ Yes
rule.params.col	String	`\"Item ID\"`	Source column containing text for language detection.	✅ Yes
rule.params.as	String	`\"New column\"`	Target column to store detected language output.	✅ Yes
rule.params.type	String (MLType)	`\"lang_predict\"`	Specifies language detection as the ML operation.	✅ Yes
rule.params.options	Map[String, String]	`{\"lang_type\":\"name\"}`	Defines the language output format (`name` or `code`).	❌ No

22. Sentiment analysis

This API will analyze the sentiment of text values in a column.

Sample input

{\"rule\":{\"name\":\"MlDerive\",\"params\":{\"col\":\"text_column\",\"as\":\"sentiment\",\"type\":\"sentiment\",\"options\":{\"model\":\"default\"}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the ML derive instruction	✅ Yes
rule.name	String	\"MlDerive\"	Specifies the ML derive transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for ML derivation	✅ Yes
rule.params.col	String	\"text_column\"	Source column containing text for sentiment analysis	✅ Yes
rule.params.as	String	\"sentiment\"	Target column to store the derived sentiment output	✅ Yes
rule.params.type	String (MLType)	\"sentiment\"	Specifies sentiment analysis as the ML operation	✅ Yes
rule.params.options	Map[String, String]	{\"model\":\"default\"}	Optional ML configuration such as model selection	❌ No

23. Truncate

This API removes unnecessary characters or words from the end of text values.

Sample input

{\"rule\":{\"name\":\"Truncate\",\"params\":{\"cols\":[\"description\"],\"n\":100,\"isChar\":true}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the truncate transform instruction	✅ Yes
rule.name	String	`\"Truncate\"`	Specifies the truncate transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for truncation	✅ Yes
rule.params.cols	Array of Strings	`[\"description\"]`	Columns whose values need to be truncated	✅ Yes
rule.params.n	Integer	`100`	Maximum length to truncate the column value	✅ Yes
rule.params.isChar	Boolean	`true`	Determines whether truncation is based on characters (`true`) or words (`false`)	❌ No

24. Merge

The Merge API is used to combine two or more columns into a single column based on specific conditions.

Sample input
{\"rule\":{\"name\":\"merge\",\"params\":{\"formula\":\"Sales,'-',Cost\",\"as\":\"SalesCost\",\"dropSrc\":true}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	`\"merge\"`	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Contains the parameters required for the merge transform	✅ Yes
rule.params.formula	String	`Sales`,'-',`Cost`	Expression defining how source columns and literals are merged	✅ Yes
rule.params.as	String	`\"SalesCost\"`	Name of the newly created column after merge	✅ Yes
rule.params.dropSrc	Boolean	`true`, `false`	Indicates whether the source columns should be dropped after merge	❌ No
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	`\"column_merge\"`	Specifies the transform category	❌ No

25. Replace

Replace using regex

Replaces text in a column using a regex of the value which you want to replace

Sample input
{\"rule\":{\"name\":\"ReplaceRegEx\",\"params\":{\"cols\":[\"phone\"],\"value\":\"\",\"regEx\":\"[^0-9]\",\"iCase\":false,\"global\":true,\"word\":false},\"meta\":{\"optionType\":\"regex\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"ReplaceRegEx\"	Specifies the replace transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for the replace transform	✅ Yes
rule.params.cols	Array[String]	[\"phone\"]	List of columns on which the replace operation is applied	✅ Yes
rule.params.value	String	\"\", \"*\\\", \"replace\"	Value used to replace the matched content	✅ Yes
rule.params.regEx	String	\"[^0-9]\"	Regular expression pattern used to identify values to be replaced	✅ Yes
rule.params.iCase	Boolean	true, false (default: false)	Case-insensitive regex matching	❌ No
rule.params.global	Boolean	true, false (default: false)	Replaces all matching occurrences	❌ No
rule.params.word	Boolean	true, false (default: false)	Matches whole words only	❌ No
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	\"regex\"	Specifies the replace category	❌ No

Replace using pattern

Replaces text using a pattern

Sample input

{\"rule\":{\"name\":\"replacetext\",\"params\":{\"cols\":[\"Region\",\"Sales\"],\"value\":\"X\",\"delimiter\":{\"type\":\"pattern\",\"from\":\"{digit}{3}\"}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"replacetext\"	Specifies the replace-text transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for the transform	✅ Yes
rule.params.cols	Array of Strings	[\"Region\",\"Sales\"]	Columns on which the replace operation is applied	✅ Yes
rule.params.value	String	\"X\"	Value used to replace the matched pattern	✅ Yes
rule.params.delimiter	Object	–	Defines the pattern-based replacement configuration	✅ Yes
rule.params.delimiter.type	String	\"pattern\"	Specifies the type of replacement matching (pattern/text)	✅ Yes
rule.params.delimiter.from	String	\"{digit}{3}\"	Pattern expression that defines what to replace	✅ Yes
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	Example: \"pattern_replace\"	Specifies the transform category	❌ No

Replace using text

Replace the value that matches with the given text

Sample request

{\"rule\":{\"name\":\"ReplaceText\",\"params\":{\"cols\":[\"description\"],\"value\":\"replacement\",\"delimiter\":{\"on\":\"old_text\"},\"iCase\":false,\"global\":true,\"word\":false}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"ReplaceText\"	Specifies the replace-text transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for the transform	✅ Yes
rule.params.cols	Array of Strings	[\"description\"]	Columns on which the replace operation is applied	✅ Yes
rule.params.value	String	\"replacement\"	Value used to replace the matched text	✅ Yes
rule.params.delimiter	Object	{ \"on\": \"old_text\" }	Defines the text/pattern matching configuration	✅ Yes
rule.params.delimiter.on	String	\"old_text\"	Text or pattern that should be replaced	✅ Yes
rule.params.iCase	Boolean	false	Enables case-insensitive matching	❌ No
rule.params.global	Boolean	true	Replaces all occurrences when enabled	❌ No
rule.params.word	Boolean	false	Restricts replacement to whole-word matches	❌ No

Replace using position value

Replace the first n characters or the last n characters. Specify the number of characters to replace from the start or end of the value.

First 'n' characters

{\"rule\":{\"name\":\"replacepositions\",\"params\":{\"cols\":[\"sales\"],\"value\":\"replace\",\"at\":{\"len\":10}}}}

Last 'n' characters

{\"rule\":{\"name\":\"replacepositions\",\"params\":{\"cols\":[\"category\"],\"value\":\"\",\"at\":{\"len\":10,\"last\":true}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"replacepositions\"	Specifies the replace-positions transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for the transform	✅ Yes
rule.params.cols	Array of Strings	[\"category\"]	Columns on which the replace operation is applied	✅ Yes
rule.params.value	String	\"\"	Value used to replace the characters at the specified positions	✅ Yes
rule.params.at	Object	{ \"len\": 10, \"last\": true }	Defines the positional replacement configuration	✅ Yes
rule.params.at.len	Integer	10	Number of characters to replace	❌ No
rule.params.at.last	Boolean	true / false	When true, replacement starts from the end of the string. When false, it starts from the beginning	❌ No

Replace Start and End Index

Replace the value by specifying the start index and the end index. The replacement begins from the start index (default is 1) and continues up to the specified end index.

Sample input

{\"rule\":{\"name\":\"replacepositions\",\"params\":{\"cols\":[\"category\"],\"value\":\"replace\",\"at\":{\"from\":1,\"to\":2}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"replacepositions\"	Specifies the replace-by-position transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for the transform	✅ Yes
rule.params.cols	Array of Strings	[\"category\"]	Columns on which the replace-by-position operation is applied	✅ Yes
rule.params.value	String	\"replace\"	Value used to replace characters at the specified positions	✅ Yes
rule.params.at	Object (TextPositionInfo)	{ \"from\": 1, \"to\": 2 }	Defines the position-based replacement configuration	✅ Yes
rule.params.at.from	Integer	1	Starting position (0-based index) for replacement	❌ No
rule.params.at.to	Integer	2	Ending position for replacement	❌ No
rule.params.at.len	Integer	null	Number of characters to replace; used when from and to are not specified	❌ No
rule.params.at.last	Boolean	false	Indicates whether the replacement should be applied from the end of the value	❌ No

Replace Start and Length

Replace the value by specifying the start index and the length. The replacement begins from the start index (default is 1) and continues for the specified length.

Sample input

{\"rule\":{\"name\":\"replacepositions\",\"params\":{\"cols\":[\"category\"],\"value\":\"replace\",\"at\":{\"from\":1,\"len\":2}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"replacepositions\"	Specifies the replace-by-position transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for the transform	✅ Yes
rule.params.cols	Array of Strings	[\"category\"]	Columns on which the replace-by-position operation is applied	✅ Yes
rule.params.value	String	\"replace\"	Value used to replace characters at the specified positions	✅ Yes
rule.params.at	Object (TextPositionInfo)	{ \"from\": 1, \"len\": 2 }	Defines the position-based replacement configuration	✅ Yes
rule.params.at.from	Integer	1	Starting position (0-based index) for replacement	❌ No
rule.params.at.to	Integer / null	null	Ending position for replacement; optional when len is used	❌ No
rule.params.at.len	Integer	2	Number of characters to replace starting from from	❌ No
rule.params.at.last	Boolean	false	Indicates whether replacement should be applied from the end of the value	❌ No

26. Round off

The Round Off API is used to round numeric values in a column to a specified number of decimal places.

Sample input

{\"rule\":{\"name\":\"roundoff\",\"params\":{\"cols\":[\"Sales\",\"Cost\"],\"type\":\"roundoff\",\"n\":3}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"roundoff\"	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Contains the parameters required for the roundoff transform	✅ Yes
rule.params.cols	Array of Strings	[\"Sales\", \"Cost\"]	List of numeric columns on which the roundoff operation is applied	✅ Yes
rule.params.type	String	\"roundoff\"	Defines the rounding operation	✅ Yes
rule.params.n	Number	3	Number of decimal places to round the values to	✅ Yes
rule.meta	Object	–	Metadata related to the transform rule	❌ Optional
rule.meta.optionType	String	Example: \"numeric\"	Specifies the transform category	❌ Optional

27. Select transform

The Select API helps you select or rename columns in a stage

Select

Sample input

{\"rule\":{\"name\":\"select\",\"params\":{\"formulaList\":[{\"formula\":\"abs(`cost`)\",\"as\":\"Abs\"},{\"formula\":\"`Sales`\",\"as\":\"Sales1\"}]}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"select\"	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Contains the parameters required for the select transform	✅ Yes
rule.params.formulaList	Array of Objects	–	List of expressions used to select or derive output columns	✅ Yes
rule.params.formulaList[].formula	String	abs(`cost`), `Sales`	Expression defining the column or calculation	✅ Yes
rule.params.formulaList[].as	String	\"Abs\", \"Sales1\"	Output column name for the evaluated formula	✅ Yes
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	Example: \"column_selection\"	Specifies the transform category	❌ No

Rename

Sample input

{\"rule\":{\"name\":\"rename\",\"params\":{\"colList\":[{\"col\":\"A\",\"as\":\"Region\"}]}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"rename\"	Specifies the Rename transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for renaming columns	✅ Yes
rule.params.colList	Array of Objects	–	List of columns to rename	✅ Yes
rule.params.colList[].col	String	\"A\"	Original column name to be renamed	✅ Yes
rule.params.colList[].as	String	\"Region\"	New column name	✅ Yes
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	\"rename_column\"	Specifies the transform category	❌ No

28. Split

This API allows you to split values in the selected columns based on a specified delimiter or pattern and generate multiple columns.

Sample input

{\"rule\":{\"name\":\"spliton\",\"params\":{\"colList\":[{\"col\":\"Region\",\"as\":\"R1\"},{\"col\":\"Sales\",\"as\":\"S1\"}],\"into\":\"columns\",\"on\":[\" \"],\"limit\":2,\"type\":\"text\"}}}

The table below details the input parameters for all available Split options, including Start and End Index, Start and End Length, Delimiter, Regex, and Whitespaces. Click here to know more

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the split instruction	✅ Yes
rule.name	String	\"SplitOn\", \"SplitPositions\", \"splittext\"	Specifies the split operation type	✅ Yes
rule.params	Object	–	Contains parameters required for the split operation	✅ Yes
rule.params.colList	Array of Objects	[{\"col\":\"tags\",\"as\":\"tag_array\"}]	Source column and output column name	✅ Yes
rule.params.into	String	\"array\", \"columns\"	Output format of the split result	❌ No (depends on rule)
rule.params.type	String	\"text\"	Indicates text-based splitting	✅ Yes (for delimiter-based split)
rule.params.on	Array of Strings	`[\",\",\";\", \"\\n\"]`	Delimiters used to split text	✅ Yes (for delimiter-based split)
rule.params.delimiter	Object	{\"on\":\"{white_space}\"}	Pattern or special delimiter used for splitting	✅ Yes (for pattern/whitespace split)
rule.params.at	Object	{\"from\":1,\"to\":2}, {\"from\":1,\"len\":10}	Defines position‑based split logic	✅ Yes (for position split)
rule.params.at.from	Integer	1	Start index for splitting	✅ Yes (for position split)
rule.params.at.to	Integer	2	End index for splitting	✅ Yes (for position split)
rule.params.at.len	Integer	10	Number of characters to split from start index	⚠️ Conditional (for length-based split)
rule.params.at.last	Boolean	false	Split from the end of the string	❌ No
rule.params.limit	Integer	2	Maximum number of splits	❌ No
rule.params.iCase	Boolean	false	Case‑insensitive split behavior	❌ No

The split options are explained below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

rule.name	Split logic	Description
SplitOn	Delimiter‑based split	Splits text using one or more specified delimiters
splittext	Pattern / whitespace / regex‑based split	Splits text based on a pattern, whitespace, or regular expression
SplitPositions	Position‑based split	Splits text using start and end index, or start index and length

29. Trim spaces

The Trim Spaces API is used to remove leading, trailing spaces and empty lines from text a column.

Sample input

{\"rule\":{\"name\":\"trim\",\"params\":{\"cols\":[\"Region\",\"Sales\"],\"types\":[\"ltrim\",\"rtrim\"]}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"roundoff\"	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Contains the parameters required for the roundoff transform	✅ Yes
rule.params.cols	Array of Strings	[\"Sales\", \"Cost\"]	List of numeric columns on which the roundoff operation is applied	✅ Yes
rule.params.type	String	\"roundoff\"	Defines the rounding operation	✅ Yes
rule.params.n	Number	3	Number of decimal places to round the values to	✅ Yes
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	Example: \"numeric\"	Specifies the transform category	❌ No

30. Truncate

This API removes unnecessary characters or words from the end of text values.

Sample input

{\"rule\":{\"name\":\"Truncate\",\"params\":{\"cols\":[\"description\"],\"n\":100,\"isChar\":true}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the truncate transform instruction	✅ Yes
rule.name	String	\"Truncate\"	Specifies the truncate transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for truncation	✅ Yes
rule.params.cols	Array of Strings	[\"description\"]	Columns whose values need to be truncated	✅ Yes
rule.params.n	Integer	100	Maximum length to truncate the column value	✅ Yes
rule.params.isChar	Boolean	true	Determines whether truncation is based on characters (true) or words (false)	❌ No

31. Unify date format

This API unifies multiple date representations into a single standardized date value.

Sample input

{\"rule\":{\"name\":\"UnifyDate\",\"params\":{\"col\":\"date_column\",\"replaceMap\":{\"2024-01-01\":[\"01/01/2024\",\"Jan 1, 2024\",\"1-Jan-2024\"]}}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the unify date transform instruction	✅ Yes
rule.name	String	\"UnifyDate\"	Specifies the unify date transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for unifying date values	✅ Yes
rule.params.col	String	\"date_column\"	Column whose date values need to be standardized	✅ Yes
rule.params.replaceMap	Map[String, Array[String]]	{\"2024-01-01\": [\"01/01/2024\", \"Jan 1, 2024\", \"1-Jan-2024\"]}	Maps a standardized date value to multiple source date formats	✅ Yes

32. Deduplicate

Row-wise

The Deduplicate API is used to remove duplicate rows from your data.

Sample input

{\"rule\":{\"name\":\"DeDuplicate\",\"params\":{\"cols\":[\"name\",\"email\"],\"iCase\":false,\"iSpace\":false,\"formula\":null,\"flag\":false,\"keep\":true}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"DeDuplicate\"	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Parameters for row-wise deduplication	✅ Yes
rule.params.cols	Array of Strings	[]	Empty array indicates row-wise deduplication (entire row comparison)	✅ Yes
rule.params.iCase	Boolean	true, false (default: false)	Case-insensitive comparison while deduplicating rows	❌ No
rule.params.iSpace	Boolean	true, false (default: false)	Ignores leading/trailing spaces during row comparison	❌ No
rule.params.formula	String	null	Conditional expression to decide which duplicate row to retain	⚠️ Conditional
rule.params.flag	Boolean	true, false (default: false)	Enables additional deduplication behavior	❌ No
rule.params.keep	Boolean	true, false (default: true)	Whether to keep one instance of duplicate rows or remove them	❌ No
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	\"row_deduplication\"	Specifies that the operation is row-wise	❌ No

Column wise

The Deduplicate API is used to remove duplicate columns from your data.

Sample input

{\"rule\":{\"name\":\"DeDuplicate\",\"params\":{\"cols\":[\"name\",\"email\"],\"iCase\":false,\"iSpace\":false,\"formula\":null,\"flag\":false,\"keep\":true}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"DeDuplicate\"	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Contains the parameters required for the deduplicate transform	✅ Yes
rule.params.cols	Array of Strings	[\"name\",\"email\"]	List of columns on which column-wise deduplication is performed	❌ No (Optional)
rule.params.iCase	Boolean	true, false (default: false)	Case-insensitive comparison for column-wise deduplication	❌ No
rule.params.iSpace	Boolean	true, false (default: false)	Ignores leading/trailing spaces while comparing column values	❌ No
rule.params.formula	String	null	Conditional expression used to determine which value/record to retain	❌ No
rule.params.flag	Boolean	true, false (default: false)	Enables additional column-wise deduplication behavior	❌ No
rule.params.keep	Boolean	true, false (default: true)	Indicates whether duplicate column values should be retained or removed	❌ No
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	\"column_deduplication\"	Specifies the transform category	❌ No

33. Filter

This API filters rows based on one or more conditions.

Sample input

{\"rule\":{\"name\":\"Filter\",\"params\":{\"criteria\":[{\"cols\":[\"age\"],\"number\":{\"type\":\"greater_than\",\"values\":[\"18\"]},\"keep\":true}],\"formula\":null,\"all\":true,\"keep\":true}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the filter transform instruction	✅ Yes
rule.name	String	\"Filter\"	Specifies the filter transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for filtering data	✅ Yes
rule.params.criteria	Array of CriteriaObject	See example above	Defines one or more filter conditions	✅ Yes
rule.params.criteria.cols	Array of Strings	[\"age\"]	Columns on which the filter condition is applied	❌ No
rule.params.criteria.number	DataTypeConstraint	{\"type\":\"greater_than\",\"values\":[\"18\"]}	Numeric comparison condition	❌ No
rule.params.criteria.number.type	String	\"greater_than\"	Type of numeric comparison	✅ Yes
rule.params.criteria.number.values	Array of Strings	[\"18\"]	Values used for comparison	✅ Yes
rule.params.criteria.keep	Boolean	true	Indicates whether matching rows are kept	❌ No
rule.params.formula	String	null	Expression‑based filtering logic	❌ No
rule.params.all	Boolean	true	Applies all criteria using AND logic when true	❌ No
rule.params.keep	Boolean	true	Final decision to keep or discard matching rows	❌ No

34. Pivot

This API reshapes data by converting rows into columns.

Sample input

{\"rule\":{\"name\":\"Pivot\",\"params\":{\"cols\":[\"category\"],\"rows\":[\"date\"],\"data\":[{\"formula\":\"SUM(amount)\",\"type\":\"normal\"}],\"limit\":100,\"intCols\":true,\"showTotal\":false,\"orderByRows\":null,\"orderByCols\":null,\"suffix\":true}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the pivot transform instruction	✅ Yes
rule.name	String	\"Pivot\"	Specifies the pivot transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for pivoting data	✅ Yes
rule.params.cols	Array of Strings	[\"category\"]	Columns whose unique values become pivoted columns	❌ No
rule.params.rows	Array of Strings	[\"date\"]	Columns that remain as row identifiers	❌ No
rule.params.data	Array of DataArgument	[{\"formula\":\"SUM(amount)\",\"type\":\"normal\"}]	Aggregation logic applied during pivot	❌ No
rule.params.limit	Integer	100	Maximum number of pivoted columns allowed	❌ No
rule.params.intCols	Boolean	true	Converts pivoted column headers to integers when possible	❌ No
rule.params.showTotal	Boolean	false	Indicates whether total rows/columns should be shown	❌ No
rule.params.orderByRows	Array of OrderByInfo	null	Sorting rules applied to pivot rows	❌ No
rule.params.orderByCols	Array of OrderByInfo	null	Sorting rules applied to pivot columns	❌ No
rule.params.suffix	Boolean	true	Appends aggregation suffix to pivoted column names	❌ No

35. Unpivot

The Unpivot API is used to transform columns into rows, converting wide-format data into a long-format data.

Sample input

{\"rule\":{\"name\":\"unpivot\",\"params\":{\"cols\":[\"2012\",\"2013\",\"2014\"],\"header\":\"Year\",\"as\":\"Revenue\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"unpivot\"	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Contains the parameters required for the unpivot transform	✅ Yes
rule.params.cols	Array of Strings	[\"2012\",\"2013\",\"2014\"]	List of columns to be unpivoted into rows	✅ Yes
rule.params.header	String	\"Year\"	Name of the new column that stores the original column headers	✅ Yes
rule.params.as	String	\"Revenue\"	Name of the new column that stores the unpivoted values	✅ Yes
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	Example: \"data_reshaping\"	Specifies the transform category	❌ No

36. Join

This API helps you join two datasets together using common columns.

Note: Use the sample ID of the first dataset in the path parameters.

Sample input

{\"rule\":{\"name\":\"join\",\"params\":{\"withDS\":[{\"dsName\":\"XY\",\"dsInfo\":{\"dsID\":\"54321678968\"}}],\"colList\":[{\"cols\":[\"DS1.Region\",\"DS.Region\"],\"as\":\"Region\"}],\"type\":\"inner\",\"keys\":[{\"cols\":[\"DS1.id\",\"DS.id\"],\"iCase\":true}]}}}

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the transform instruction	✅ Yes
rule.name	String	\"join\"	Specifies the transform operation to apply	✅ Yes
rule.params	Object	–	Contains the parameters required for the join transform	✅ Yes
rule.params.withDS	Array of Objects	–	Defines the dataset(s) to join with	✅ Yes
rule.params.withDS[].dsName	String	\"XY\"	Name/alias of the dataset to join	✅ Yes
rule.params.withDS[].dsInfo	Object	–	Metadata of the join dataset	✅ Yes
rule.params.withDS[].dsInfo.dsID	String	\"54321678968\"	Unique identifier of the 2nd dataset to join	✅ Yes
rule.params.colList	Array of Objects	–	List of columns to select from joined datasets	✅ Yes
rule.params.colList[].cols	Array of Strings	[\"DS1.Region\",\"DS.Region\"]	Source columns from primary and joined datasets	✅ Yes
rule.params.colList[].as	String	\"Region\"	Output column name after join	✅ Yes
rule.params.type	String	\"inner\", \"left\", \"right\", \"full\"	Type of join to perform	✅ Yes
rule.params.keys	Array of Objects	–	Join key definitions	✅ Yes
rule.params.keys[].cols	Array of Strings	[\"DS1.id\",\"DS.id\"]	Columns used as join keys from both datasets	✅ Yes
rule.params.keys[].iCase	Boolean	true, false	Indicates whether the join is case-insensitive	❌ No
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	Example: \"dataset_join\"	Specifies the transform category	❌ No

37. Append

This API appends data from another dataset by performing a union operation between datasets.

Note: Use the sample ID of the first dataset in the path parameters.

Sample input

{\"rule\":{\"name\":\"Union\",\"params\":{\"withDS\":[{\"dsName\":\"dataset2\",\"dsInfo\":{\"dsID\":\"54321678968\"}}],\"colList\":[{\"cols\":[\"col1\",\"col2\"],\"as\":\"merged_col\"}],\"type\":\"union_all\",\"intCols\":true,\"all\":false}}}

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the union transform instruction	✅ Yes
rule.name	String	\"Union\"	Specifies the union transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for the union operation	✅ Yes
rule.params.withDS	Array of Objects	–	Defines the dataset(s) to union with the primary dataset	✅ Yes
rule.params.withDS[].dsName	String	\"dataset2\"	Name/alias of the dataset to be combined	✅ Yes
rule.params.withDS[].dsInfo	Object	–	Metadata of the dataset to be unioned	✅ Yes
rule.params.withDS[].dsInfo.dsID	String	\"54321678968\"	Unique identifier of the second dataset to union	✅ Yes
rule.params.colList	Array of Objects	–	List of columns to be mapped or merged during the union	❌ No
rule.params.colList[].cols	Array of Strings	[\"col1\",\"col2\"]	Source columns from the datasets	❌ No
rule.params.colList[].as	String	\"merged_col\"	Output column name after union	❌ No
rule.params.type	String	\"union_all\", \"union_distinct\"	Type of union operation to perform	❌ No
rule.params.intCols	Boolean	true, false	Aligns columns by index instead of column name	❌ No
rule.params.all	Boolean	true, false	Specifies whether duplicate rows should be included	❌ No
rule.meta	Object	–	Metadata related to the transform rule	❌ No
rule.meta.optionType	String	Example: \"dataset_union\"	Specifies the transform category	❌ No

38. Mark as personal data

This API allows you to mark columns as personal (PII) and ePHI data enabling privacy.

Sample input

{\"rule\":{\"name\":\"SetPrivacy\",\"params\":{\"cols\":[\"email\",\"phone\"],\"isPii\":true,\"colList\":null}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the set privacy instruction	✅ Yes
rule.name	String	\"SetPrivacy\"	Specifies the set privacy transform operation	✅ Yes
rule.params	Object	–	Contains parameters required for marking personal data	✅ Yes
rule.params.cols	Array[String]	[\"email\",\"phone\"]	List of columns to be marked as personal or non‑personal data	❌ No (default: empty)
rule.params.isPii	Boolean	true, false	Indicates whether the specified columns contain personal data	❌ No (default: true)
rule.params.colList	Array[RuleColumnMapInfoForPii]	null	Column‑level mapping for advanced PII configuration	❌ No

39. Add formula

This API creates a new column by applying various formula functions to existing columns. We have 250+ formula functions in DataPrep.

Sample input

{\"rule\":{\"name\":\"Derive\",\"params\":{\"formula\":\"age \\\\\\\\\\* 2\",\"as\":\"double_age\",\"index\":null,\"groupBy\":null,\"orderBy\":null,\"type\":\"single\"}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the derive transform instruction	✅ Yes
rule.name	String	\"Derive\"	Specifies the derive transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for deriving a column	✅ Yes
rule.params.formula	String	\"age * 2\"	Expression used to compute the derived value	✅ Yes
rule.params.as	String	\"double_age\"	Name of the newly derived column	✅ Yes
rule.params.index	Integer	null	Position at which the new column is inserted	❌ No
rule.params.groupBy	Array of Strings	null	Columns used for grouping before applying the formula	❌ No
rule.params.orderBy	Array of OrderByInfo	null	Ordering applied before formula evaluation	❌ No
rule.params.type	DeriveType	\"single\"	Specifies a row‑level derive operation	❌ No

40. Window functions

This API creates a new column using a window function evaluated over partitions of data.

Sample input

{\"rule\":{\"name\":\"Derive\",\"params\":{\"type\":\"window\",\"formula\":\"row_number()\",\"as\":\"New column_1\",\"groupBy\":[\"Lead Status\"],\"orderBy\":[{\"col\":\"LEADID\",\"desc\":false}]}}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Possible Values (Example)	Description	Mandatory
rule	Object	–	The rule block that contains the derive transform instruction	✅ Yes
rule.name	String	\"Derive\"	Specifies the derive transform operation	✅ Yes
rule.params	Object	–	Contains the parameters required for window-based derivation	✅ Yes
rule.params.type	DeriveType	\"window\"	Specifies a window function derive operation	✅ Yes
rule.params.formula	String	\"row_number()\"	Window function used to derive values	✅ Yes
rule.params.as	String	\"New column_1\"	Name of the newly derived column	✅ Yes
rule.params.groupBy	Array of Strings	[\"Lead Status\"]	Defines partitions for the window function	✅ Yes
rule.params.orderBy	Array of OrderByInfo	[{\"col\":\"LEADID\",\"desc\":false}]	Ordering applied within each partition	✅ Yes
rule.params.index	Integer	null	Position at which the new column is inserted	❌ No

ii) To Re‑Order Rules

Use the Apply Rules API and in the input:

Set rule.name as \"reorder\"
\n
Pass the ordered list of rule IDs in params.rules
\n

Sample Input:

{ \"rule\": { \"name\": \"reorder\", \"params\": { \"rules\": [\"55317000000067039\", \"55317000000067023\"] }, \"meta\": null }, \"widgetCols\": [\"id\", \"name\", \"age\"] }

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{ ... }`	Contains rule configuration for the reorder operation.	✅ Yes
`rule.name`	String	`\"reorder\"`	Specifies that this rule is for reordering existing rules.	✅ Yes
`rule.params`	Object	`{ \"rules\": [...] }`	Parameters required for the reorder rule.	✅ Yes
`rule.params.rules`	Array of Strings	`[\"55317000000067039\",\"55317000000067023\"]`	List of rule IDs in the exact execution order.	✅ Yes
`rule.meta`	Object / null	`null`	Reserved for future use.	❌ No
`widgetCols`	Array of Strings	`[\"id\",\"name\",\"age\"]`	Columns to refresh after rule execution (UI-related).	❌ No

iii) To Enable / Disable / Remove Rules

This is used to enable, disable, or remove one or more transform rules from a dataset (ruleset).

Use the Apply Rules API and in the input:

Set rule.name as:
\n
- \"enable\" → to enable rules
  \n
- \"disable\" → to disable rules
  \n
- \"remove\" → to delete rules
  \n
\n
Pass the list of rule IDs in params.rules
\n

Sample input:

{\"rule\":{\"name\":\"disable\",\"params\":{\"rules\":[\"55317000000067039\"]},\"meta\":null}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`rule`	Object	`{ ... }`	Rule configuration object.	✅ Yes
`rule.name`	String	`\"disable\"` / `\"enable\"` / `\"remove\"`	Action to perform on existing rules.	✅ Yes
`rule.params`	Object	`{ \"rules\": [...] }`	Parameters required for the rule action.	✅ Yes
`rule.params.rules`	Array of Strings	`[\"55317000000067039\"]`	List of rule IDs to be enabled, disabled, or removed.	✅ Yes
`rule.meta`	Object / null	`null`	Reserved for future use.	❌ No

iv) Edit rule

This API is used to modify an existing transform rule in a dataset by replacing it with a new rule configuration.

Use the same Apply Rules API and give the input as given below:

When editing an existing rule, the request must include the parent_rule field.
This field specifies the rule ID that should be updated.

If parent_rule is not provided, the API will treat the request as adding a new rule instead of editing an existing one.

Sample input

{\"parent_rule\":\"55317000000196055\",\"rule\":{\"name\":\"changecase\",\"params\":{\"cols\":[\"name\"],\"type\":\"camel\"},\"meta\":null},\"widgetCols\":[\"name\",\"1\",\"2\",\"3\"]}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`parent_rule`	String	`\"55317000000196055\"`	ID of the existing rule that needs to be edited.	✅ Yes
`rule`	Object	`{ ... }`	New rule definition that will replace the existing rule.	✅ Yes
`rule.name`	String	`\"changecase\"`	Transform type to apply (e.g., change text case).	✅ Yes
`rule.params`	Object	`{ \"cols\": [...], \"type\": \"camel\" }`	Parameters required for the change‑case rule.	✅ Yes
`rule.params.cols`	Array of Strings	`[\"name\"]`	Columns in which the case change should be applied.	✅ Yes
`rule.params.type`	String	`\"upper\"` / `\"lower\"` / `\"title\"` / `\"camel\"`	Type of case transformation.	✅ Yes
`rule.meta`	Object / null	`null`	Reserved for metadata.	❌ No
`widgetCols`	Array of Strings	`[\"name\",\"1\",\"2\",\"3\"]`	Columns to refresh after rule update (UI‑related).	❌ No

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","datasetsamples",":{{sample_id}}","apply"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"0962f4f9-61cb-4e88-a550-954b13651789","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"97f185f9-5842-47a1-9cb2-5690b5ee773b","description":{"content":"

Provide the sample ID of the stage where you want to apply a transform. You can get from the response Get pipelines info API.\nSteps to get sample_id:

In the Pipeline info response, locate the Transform task (type = 10) in pipelinetasks
Navigate through the nested objects: dataset → selected_sample.
Use the value of selected_sample.id as the {sample_id}.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{sample_id}}"}]}},"response":[{"id":"7ccf4562-33e5-4a71-a2d3-576f1a37a46d","name":"Apply rules - transforms","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rule\":{\"name\":\"changecase\",\"params\":{\"cols\":[\"Region\"],\"type\":\"upper\"}}}","description":"sample input for change case transform","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasetsamples/55317000000163443/apply"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"samplestate\": {\n \"id\": \"55317000000175025\",\n \"rule\": {\n \"id\": \"55317000000175021\",\n \"rule_json\": \"{\\\"name\\\":\\\"changecase\\\",\\\"params\\\":{\\\"cols\\\":[\\\"Lead Owner\\\"],\\\"type\\\":\\\"upper\\\"},\\\"meta\\\":null}\",\n \"type\": \"TRANSFORM_RULE\",\n \"description\": null,\n \"created_time\": \"1767706912724\",\n \"created_by\": {\n \"id\": \"55317000000011001\"\n }\n },/////////////"},{"id":"9099510a-5199-4c49-a04c-7559c956b206","name":"Re-order rules","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\n \"rule\": {\n \"name\": \"reorder\",\n \"params\": {\n \"rules\": [\"55317000000067039\", \"55317000000067023\"]\n },\n \"meta\": null\n },\n \"widgetCols\": [\"id\", \"name\", \"age\"]\n}","description":"sample input to re-order rules","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasetsamples/55317000000163443/apply"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Rules in the dataset are reordered successfully and will now execute in the new specified sequence.\n\n{\n \"samplestate\": {\n \"id\": \"55317000000196089\",\n \"rule\": {\n \"id\": \"55317000000196039\",\n \"rule_json\": \"{\\\"name\\\":\\\"fill\\\",\\\"params\\\":{\\\"type\\\":\\\"mode\\\",\\\"cols\\\":[\\\"id\\\"]},\\\"meta\\\":\\\"{\\\\\\\"type\\\\\\\":\\\\\\\"mode\\\\\\\"}\\\"}\",\n \"type\": \"TRANSFORM_RULE\",\n \"description\": null,\n \"created_time\": \"1769154670278\",\n \"created_by\": {\n \"id\": \"55317000000022189\"\n }////////\n"},{"id":"d3e49dbc-8623-4290-91ea-a15df183bbcf","name":"To Enable / Disable / Remove Rules","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rule\":{\"name\":\"disable\",\"params\":{\"rules\":[\"55317000000067039\"]},\"meta\":null}} ","description":"sample input to Enable / Disable / Remove Rules","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasetsamples/55317000000163443/apply"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"samplestate\": {\n \"id\": \"55317000000196123\",\n \"rule\": {\n \"id\": \"55317000000196039\",\n \"rule_json\": \"{\\\"name\\\":\\\"fill\\\",\\\"params\\\":{\\\"type\\\":\\\"mode\\\",\\\"cols\\\":[\\\"1\\\"]},\\\"meta\\\":\\\"{\\\\\\\"type\\\\\\\":\\\\\\\"mode\\\\\\\"}\\\"}\",\n \"type\": \"TRANSFORM_RULE\",\n \"description\": null,\n \"created_time\": \"1769154670278\",\n \"created_by\": {\n \"id\": \"55317000000022189\"\n }\n },\n \"datasetsample\": {\n \"id\": \"55317000000187441\",\n \"dataset\": {\n \"id\": \"55317000000187429\"\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n },//////"},{"id":"a63c0dd1-12cf-419b-8953-b97279525e78","name":"Edit rule","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"parent_rule\":\"55317000000196055\",\"rule\":{\"name\":\"changecase\",\"params\":{\"cols\":[\"name\"],\"type\":\"camel\"},\"meta\":null},\"widgetCols\":[\"name\",\"1\",\"2\",\"3\"]}","description":"sample input to edit rule","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasetsamples/55317000000163443/apply"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"samplestate\": {\n \"id\": \"55317000000196211\",\n \"rule\": {\n \"id\": \"55317000000196039\",\n \"rule_json\": \"{\\\"name\\\":\\\"fill\\\",\\\"params\\\":{\\\"type\\\":\\\"mode\\\",\\\"cols\\\":[\\\"1\\\"]},\\\"meta\\\":\\\"{\\\\\\\"type\\\\\\\":\\\\\\\"mode\\\\\\\"}\\\"}\",\n \"type\": \"TRANSFORM_RULE\",\n \"description\": null,\n \"created_time\": \"1769154670278\",\n \"created_by\": {\n \"id\": \"55317000000022189\"\n }\n },\n \"datasetsample\": {\n \"id\": \"55317000000187441\",\n \"dataset\": {\n \"id\": \"55317000000187429\"\n },\n \"current_rule\": {\n \"id\": \"55317000000196197\"\n },/////\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n },/////\n"}],"_postman_id":"38e7e86c-4f2c-488f-bc7f-ce68ecb45d2d"},{"name":"Load sample","id":"5c1f7784-83fe-4f50-887a-c6072a8e05f1","protocolProfileBehavior":{"disabledSystemHeaders":{"content-length":true,"user-agent":true,"accept-encoding":true,"connection":true,"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"list_info\":{\"start_index\":1,\"row_count\":10}}","description":"

sample input

\n","type":"text","uuid":"62e1e5f3-eaa4-4c49-b4ea-3257d49adbac"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasetsamples/:{{sample_id}}/load","description":"

The Load Sample API is used to load a sample set of records from a dataset into the pipeline for preview and validation. It helps users verify data structure, column values, and applied transformations before executing the full data load or export.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"list_info\":{\"start_index\":1,\"row_count\":10}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description	Mandatory
`list_info.start_index`	Integer	Row index to start fetching data from (1‑based).	✅ Yes
`list_info.row_count`	Integer	Number of rows to load.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","datasetsamples",":{{sample_id}}","load"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"86cbe983-26fe-4d01-b88a-442f8df7fab7","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"5e2d0086-de67-4e1c-8936-a0ecaedb2d14","description":{"content":"

Provide the sample ID of the stage from which you want to fetch the column names. You can obtain this sample ID from the response of the Get Pipeline Info API.

Steps to get sample_id:

In the Pipeline info response, locate the Transform task (type = 10) in pipelinetasks
Navigate through the nested objects: dataset → selected_sample.
Use the value of selected_sample.id as the {sample_id}.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{sample_id}}"}]}},"response":[{"id":"37405fe8-1a83-4b64-884b-8db2b9b976cf","name":"Load sample","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"v3+json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"list_info\":{\"start_index\":1,\"row_count\":10}}","description":"sample input","type":"text","uuid":"ac9a0bd3-c125-4f46-a69f-8131ce935c4f"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasetsample/55317000000144047/load"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"You can get the column names from the columnModel section of the response.\n\n{\n \"samplestate\": {\n \"samplestate\": {\n \"rowCount\": 199,\n \"colCount\": 13,\n \"intColCount\": 2,\n \"dataTypeCount\": 4,\n \"quality\": {\n \"valid\": 1979,\n \"invalid\": 11,\n \"missing\": 199\n },\n \"inputDSDetails\": {\n \"status\": \"success\",\n \"rowCount\": \"199\",\n \"colCount\": \"13\",\n \"size\": \"17960\"\n },\n \"fileSize\": 17995,\n \"nextIndex\": 13,\n \"columnModel\": [\n {\n \"displayName\": \"Badge id\",\n \"name\": \"_c0\",\n \"index\": 2,\n \"dataType\": {\n \"name\": \"number\",\n \"baseType\": \"number\",\n \"format\": {\n \"disable\": false,\n \"format\": \"##0\"\n },\n \"hasUnits\": false,\n \"hasConstraints\": false,\n \"isMandatory\": false\n },\n \"userInferredType\": false,\n \"status\": \"ADDED\",\n \"columnType\": \"INTERNAL\",\n \"involved\": false,\n \"widgets\": {},///////\n"}],"_postman_id":"5c1f7784-83fe-4f50-887a-c6072a8e05f1"},{"name":"Get Ruleset History","id":"e4d591bb-7ca0-41a7-a77e-39cd758bd856","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasetsamples/:{{sample_id}}/ruleset_history","description":"

This API is used to retrieve the complete history of rules applied to a dataset sample, including import rules and transform rules, along with their execution order, status, and metadata.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"167abdef-b31c-4e50-bc40-5a2e40f12acd","description":{"content":"

Provide the sample ID of the stage from which you want to fetch the ruleset history. You can obtain this sample ID from the response of the Get Pipeline Info API.

Steps to get sample_id:

In the Pipeline info response, locate the Transform task (type = 10) in pipelinetasks
Navigate through the nested objects: dataset → selected_sample.
Use the value of selected_sample.id as the {sample_id}.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{sample_id}}"}]}},"response":[{"id":"c2ec0717-6054-4f88-b46b-39d273bfa12a","name":"Get Ruleset history","originalRequest":{"method":"GET","header":[],"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasetsamples/55317000000144047/ruleset_history"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"Where to Find IDs in the Response\nRule ID -> ruleset.ruleset_history[].id\nRule Type -> ruleset.ruleset_history[].type\nIMPORT_RULE – Import stage rule\nTRANSFORM_RULE – Transformation applied on dataset\n\nYou can find the ruleset_audit ID under the id field within the rulesetaudit key.\n\n{\n \"ruleset\": {\n \"ruleset_history\": [\n {\n \"id\": \"55317000000058503\",\n \"type\": \"IMPORT_RULE\",\n \"description\": \"IMPORT_RULE\",\n \"created_time\": \"1764237220203\",\n \"rule_history_status\": \"IMPORT_RULE\"\n },\n {\n \"id\": \"55317000000158673\",\n \"type\": \"TRANSFORM_RULE\",\n \"description\": \"Replace values in column\",\n \"created_time\": \"1766054116277\",\n \"status\": \"ENABLED\",\n \"rule_history_status\": \"ENABLED\",\n \"rulesetaudit\": {\n \"id\": \"55317000000079001\",\n \"audit_time\": \"1764592497120\",\n \"is_committed\": 1,\n \"ruleset\": {\n \"id\": \"55317000000058607\"\n },\n \"status\": 1,\n \"rules_count\": 10\n }\n }\n ]\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n}\n\n"}],"_postman_id":"e4d591bb-7ca0-41a7-a77e-39cd758bd856"},{"name":"Rename workspace","id":"fa552c05-9983-4e90-b1d4-bbb5de2e6259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project\":{\"name\":\"White Label test1\"}}","description":"

sample input

\n","type":"text","uuid":"c10ada92-1acf-4b55-ab42-7d61affc2305"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/workspace/:{{workspace_id}}/rename_workspace","description":"

This API is used to rename an existing workspace (project) within a portal. It updates only the workspace name.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"project\":{\"name\":\"White Label test1\"}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`project`	Object	`{}`	Workspace object.	✅ Yes
`project.name`	String	`\"White Label test1\"`	New name for the workspace.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","workspace",":{{workspace_id}}","rename_workspace"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"fb182629-aa89-4d7c-8188-bc45418065be","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"3108574f-0a43-4b8d-8a5a-1ee3e1245cd8","description":{"content":"

Provide the Unique ID of the workspace to be renamed. You can get the workspace ID from the GET all Workspaces API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{workspace_id}}"}]}},"response":[{"id":"e7b8070d-bbd8-42c5-b9d0-ba7163777749","name":"Rename workspace","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project\":{\"name\":\"White Label test1\"}}","type":"text","uuid":"53399cb5-8818-45b6-8395-7e8b84418610"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/workspace/55317000000022199/rename_workspace"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"\n{\n \"project\": {\n \"id\": \"55317000000022199\",\n \"name\": \"White Label test-1\",\n \"status\": 1,\n \"is_locked\": false\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n}"}],"_postman_id":"fa552c05-9983-4e90-b1d4-bbb5de2e6259"},{"name":"Rename pipeline","id":"6af63385-0df7-4db7-92d2-3fec51c2ca43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"pipeline\":{\"name\":\"My pipeline1\"}}","description":"

sample input

\n","type":"text","uuid":"c10ada92-1acf-4b55-ab42-7d61affc2305"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/pipelines/:{{pipeline_id}}/rename_pipeline","description":"

This API is used to rename an existing pipeline within a workspace. It updates only the pipeline name.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"pipeline\":{\"name\":\"My pipeline1\"}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`pipeline`	Object	`{}`	Pipeline object.	✅ Yes
`pipeline.name`	String	`\"Pipeline 1\"`	New name for the pipeline.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","pipelines",":{{pipeline_id}}","rename_pipeline"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"a5efef3f-3eed-4bc5-b7c0-2b12ddf08ea6","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"43bc88bd-ebb4-4150-99c7-1269b4c6ddac","description":{"content":"

Provide the Unique ID of the pipeline to be renamed. You can get the pipeline ID from the GET all pipelines API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{pipeline_id}}"}]}},"response":[{"id":"995b0530-cce5-4fd4-9dfb-d45f2425f097","name":"Rename pipeline","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"project\":{\"name\":\"White Label test1\"}}","type":"text","uuid":"53399cb5-8818-45b6-8395-7e8b84418610"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/pipelines/55317000000144047/rename_pipeline"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"\n{\n \"pipeline\": {\n \"id\": \"553170000000XXXXX\",\n \"name\": \"Pipeline 1\",\n \"status\": 1\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n}"}],"_postman_id":"6af63385-0df7-4db7-92d2-3fec51c2ca43"},{"name":"Rename stage","id":"f9b4b214-19fc-4012-b484-8a8442c9f393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"dataset\":{\"name\":\"Dubai Leads_2\"}}","description":"

sample input

\n","type":"text","uuid":"c10ada92-1acf-4b55-ab42-7d61affc2305"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/datasets/:{{dataset_id}}/rename_stage","description":"

This API is used to rename an existing stage within a pipeline. It updates only the stage name.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"dataset\":{\"name\":\"Dubai Leads_2\"}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`dataset`	Object	`{}`	Dataset (stage) object.	✅ Yes
`dataset.name`	String	`\"Dubai Leads_2\"`	New name for the stage.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","datasets",":{{dataset_id}}","rename_stage"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"4f9e1ca3-8ad9-48b2-81e9-8992f27533e4","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"ce4f7e17-d9e6-4bf0-93b5-4aae2d8c300d","description":{"content":"

Provide the dataset ID of the stage which you want to rename. You can get it from the response of the Create Stage API or using Get pipelines info API.

Steps to get dataset_id:

In the Pipeline Info response, locate the pipeline task within the pipelinetasks array
Identify Transform task.
Navigate through the nested object based on the task type:
For Transform tasks: dataset → id

\n","type":"text/plain"},"type":"any","value":"string","key":"{{dataset_id}}"}]}},"response":[{"id":"b9823710-62e1-4cfd-828b-49920406929e","name":"Rename stage","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"dataset\":{\"name\":\"Dubai Leads_2\"}}","type":"text","uuid":"53399cb5-8818-45b6-8395-7e8b84418610"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/datasets/55317000000058407rename_stage"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"\n{\n \"dataset\": {\n \"id\": \"553170000000XXXXX\",\n \"name\": \"Dubai leads_2\",\n \"status\": 1\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n}\t"}],"_postman_id":"f9b4b214-19fc-4012-b484-8a8442c9f393"},{"name":"Rename raw dataset","id":"6173b526-aa0c-450e-b076-a5c509082330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rawdataset\":{\"name\":\"Dubai Leads_2\"}}","description":"

sample input

\n","type":"text","uuid":"c10ada92-1acf-4b55-ab42-7d61affc2305"}]},"url":"https://{{whitelabel_domain}}/api/v1/portals/:{{portal_name}}/rawdatasets/:{{rawdataset_id}}/rename_raw_dataset","description":"

This API is used to rename an existing stage within a pipeline. It updates only the stage name.

Service name : zohodataprep

Scope : zohodataprep.dataprepapi.CREATE, zohodataprep.dataprepapi.UPDATE, zohodataprep.dataprepapi.DELETE, zohodataprep.dataprepapi.READ

Sample input:

{\"dataset\":{\"name\":\"Dubai Leads_2\"}}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Variables / Example Values	Description	Mandatory
`dataset`	Object	`{}`	Dataset (stage) object.	✅ Yes
`dataset.name`	String	`\"Dubai Leads_2\"`	New name for the stage.	✅ Yes

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","portals",":{{portal_name}}","rawdatasets",":{{rawdataset_id}}","rename_raw_dataset"],"host":["{{whitelabel_domain}}"],"query":[],"variable":[{"id":"533f870d-4db1-4c92-bbb2-b8b596c46797","description":{"content":"

Provide your portal name. You can get it using the Get Organizations API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{portal_name}}"},{"id":"4f701788-9588-4937-a815-73a1aaca97cd","description":{"content":"

Provide the rawdataset ID which you want to rename. You can get it using Get pipelines info API.

\n","type":"text/plain"},"type":"any","value":"string","key":"{{rawdataset_id}}"}]}},"response":[{"id":"a8e7c97f-6488-4420-b15c-8f605d58d101","name":"Rename raw dataset","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"v3+json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"input_data","value":"{\"rawdataset\":{\"name\":\"Dubai Leads_2\"}}","type":"text","uuid":"53399cb5-8818-45b6-8395-7e8b84418610"}],"options":{"raw":{"language":"json"}}},"url":"https://dataprep.zylker.com/api/v1/portals/zylkerwl/rawdatasets/55317000000058375/rename_raw_dataset"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"rawdataset\": {\n \"id\": \"553170000000XXXXX\",\n \"name\": \"Dubai leads\",\n \"status\": 1\n },\n \"response_status\": {\n \"status\": \"success\",\n \"status_code\": 2000\n }\n}"}],"_postman_id":"6173b526-aa0c-450e-b076-a5c509082330"}],"id":"2b506dd0-3c73-4d70-9689-f42bb7b472ba","description":"

This folder contains the collection of Whitelabelled Zoho DataPrep version 1 APIs.

\n","_postman_id":"2b506dd0-3c73-4d70-9689-f42bb7b472ba","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"853bb2ac-4601-4412-8ff8-d96fae666b73","id":"853bb2ac-4601-4412-8ff8-d96fae666b73","name":"Zoho DataPrep REST APIs for White Label Edition","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"a568398d-9cb3-472d-9bc4-4ec6f4bd2861","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"2093e62e-43d0-4af1-ace9-e0649e161f05","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"accounts_url","value":"{{whitelabel_domain}}/accounts/op/{{portal_id}}"},{"key":"white_label_domain","value":"{{whitelabel_domain}}"}]}

Prerequisites

OAuth 2.0 Overview

Client ID and Client Secret for Third-Party apps

To register your application:

Scope

Prompting consent

Access Token

Using the Access Token

Access Token Expiry

Revoking a Refresh token

Possible error codes

Export selected rules in a template:

Sample input for FTP:

Sample input for S3:

i) Transforms

1. Change case

2. Add prefix or suffix

3. Change data type

4. Change number format

5. Change date format

6. Change time format

7. Change duration format

8. Cluster and merge transform

9. Convert units

10. Count

11. Create buckets - Date

12. Create buckets - Number

13. Create buckets - Text

14. Duplicate column

Duplicate Column Transform – Request Parameters

15. Fill empty cells

Fill Type Options

16. Extract text

17. Extract from dates

18. Extract time

19. Extract from list and map

Extract from list

Extract from map

20. Keyword extraction

21. Language detection

22. Sentiment analysis

23. Truncate

24. Merge

25. Replace

Replace using regex

Replace using pattern

Replace using text

Replace using position value

First 'n' characters

Last 'n' characters

Replace Start and End Index

Replace Start and Length

26. Round off

27. Select transform

Select

Rename

28. Split

29. Trim spaces

30. Truncate

31. Unify date format

32. Deduplicate

Row-wise

Column wise

33. Filter

34. Pivot

35. Unpivot

36. Join

37. Append

38. Mark as personal data

39. Add formula

40. Window functions

ii) To Re‑Order Rules

iii) To Enable / Disable / Remove Rules

iv) Edit rule