Get Session Reports with Zoho Assist API

Pipedream makes it easy to connect APIs for Zoho Assist and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Session Reports with the Zoho Assist API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Session Reports with the Zoho Assist API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Session Reports action
1. Connect your Zoho Assist account
2. Select a Type
3. Configure From Date
4. Configure To Date
5. Optional- Configure Email
6. Optional- Configure Index
7. Optional- Configure Count
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Session Reports with Zoho Assist API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Zoho Assist

Try it

Get Session Reports with Zoho Assist API on New Submission from Typeform API

Typeform + Zoho Assist

Try it

Get Session Reports with Zoho Assist API on Custom Events from Zoom API

Zoom + Zoho Assist

Try it

Get Session Reports with Zoho Assist API on New Submission (Instant) from Jotform API

Jotform + Zoho Assist

Try it

Get Session Reports with Zoho Assist API on New Scheduled Tasks from Pipedream API

Pipedream + Zoho Assist

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Session Reports on Zoho Assist

Description:Fetch the reports of previously conducted sessions. [See the documentation](https://www.zoho.com/assist/api/getsessionreports.html)

Version:0.0.1

Key:zoho_assist-get-session-reports

View on GitHub

Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/zoho_assist.app.mjs";
import { GET_SESSION_REPORTS_TYPE_OPTIONS } from "../../common/constants.mjs";
import { getValidDate } from "../../common/methods.mjs";
export default defineAction({
    name: "Get Session Reports",
    description: "Fetch the reports of previously conducted sessions. [See the documentation](https://www.zoho.com/assist/api/getsessionreports.html)",
    key: "zoho_assist-get-session-reports",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        type: {
            propDefinition: [
                app,
                "type",
            ],
            options: GET_SESSION_REPORTS_TYPE_OPTIONS,
        },
        fromDate: {
            propDefinition: [
                app,
                "date",
            ],
            label: "From Date",
        },
        toDate: {
            propDefinition: [
                app,
                "date",
            ],
            label: "To Date",
        },
        email: {
            type: "string",
            label: "Email",
            description: "To fetch reports conducted by specific technician.",
            optional: true,
        },
        index: {
            type: "string",
            label: "Index",
            description: "Index of the record.",
            optional: true,
        },
        count: {
            type: "integer",
            label: "Count",
            description: "Number of rows per page.",
            optional: true,
        },
    },
    methods: {
        getValidDate,
    },
    async run({ $ }) {
        const { type, fromDate, toDate, email, index, count, } = this;
        const params = {
            $,
            params: {
                type,
                fromdate: this.getValidDate(fromDate, true),
                todate: this.getValidDate(toDate, true),
                email,
                index,
                count,
            },
        };
        const { representation } = await this.app.getSessionReports(params);
        $.export("$summary", `Successfully fetched ${representation.length} session reports`);
        return representation;
    },
});

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Zoho Assist	`app`	`app`	This component uses the Zoho Assist app.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Remote Support", "value": "rs" }{ "label": "Unattended Remote Support", "value": "URS" }{ "label": "All", "value": "all" }`
From Date	`fromDate`	`string`	Timestamp in ISO 8601 format.
To Date	`toDate`	`string`	Timestamp in ISO 8601 format.
Email	`email`	`string`	To fetch reports conducted by specific technician.
Index	`index`	`string`	Index of the record.
Count	`count`	`integer`	Number of rows per page.

Authentication#

Zoho Assist uses OAuth authentication. When you connect your Zoho Assist account, Pipedream will open a popup window where you can sign into Zoho Assist and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho Assist API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoAssist.sessionapi.ALLZohoAssist.userapi.READZohoAssist.reportapi.READ