Kaizen #150 : Track and Monitor Activities in Zoho CRM using the Export Audit Log API

Kaizen #150 : Track and Monitor Activities in Zoho CRM using the Export Audit Log API

Hello all!

Welcome back to another post in our Kaizen series. 



This post details how to back up and track history of actions, such as those performed on a module (example: Leads), track actions performed by specific CRM users, and filter entries within a specific time range, using the Export Audit Log API introduced in Version 7.

Use Case

Zylker, a startup IT firm, has hired 10 project trainees for a six-month training program for the role of Technical Support Engineers. The manager at Zylker has added each trainee to the Zoho CRM as a user. These trainees interact with customers by giving product demos, attending meetings and calls, creating tasks, and being responsible for making deals won. 

Solution 

Zylker uses Zoho CRM's Export Audit Log API to track trainee activities. By exporting audit logs, the manager monitors how many calls, meetings, and tasks each trainee has completed. This helps the manager highlight areas where trainees need improvement and adjust training programs. After six months, the manager reviews the logs to decide which trainees performed well and should be offered permanent positions.

Note:
Users in the Administrator profile or CEO Role can access the audit logs. However, other users can only view their own and their sub-ordinates' audit Logs.

Exporting Audit Log

The Export Audit Log API is an asynchronous API, and an export job will be scheduled to export the audit log details. The exported audit log will be downloaded in either CSV or ZIP format, depending on the number of entries in the result. You can check the job's status using the Get the Status of the Export Audit Log Job API. Once the job is complete, you can download the results using the Download Export Audit Log Result API.

Let us see how Zylker uses the Zoho CRM API to monitor their trainees' performance.

Create Export Audit Log Job: 

Sample Request: {api-domain}/crm/{version}/settings/audit_log_export

Request Method: POST

Scope: ZohoCRM.settings.audit_logs.CREATE 

Notes:
  • The above sample request exports up to the last three years of audit log data across all modules in your Zoho CRM. 
  • The input request is optional i.e., if you skip the input request, the system will still export all actions in Zoho CRM. 
  • Use filters to export specific audit entries.

The sample input below is used to export an audit log for all 10 trainees in the Calls, Events, and Tasks modules over a six-month time range.
{
    "audit_log_export": [
        {
            "criteria": {
                "group_operator": "and",
                "group": [
                    {
                        "field": {
                            "api_name": "done_by"
                        },
                        "comparator": "in",
                        "value": [
                            {
                                "name": "Joe",
                                "id": "5725767000000583089"
                            },
                            {
                                "name": "Boyle",
                                "id": "5725767000000583000"
                            },
                            {
                                "name": "John",
                                "id": "5725767000000583001"
                            },
                            .
                            .
                            .

                        ]
                    },
                    {
                        "group_operator": "and",
                        "group": [
                            {
                                "group_operator": "and",
                                "group": [
                                    {
                                        "field": {
                                            "api_name": "audited_time"
                                        },
                                        "comparator": "between",
                                        "value": [
                                            "2024-01-05T00:00:00+05:30",
                                            "2024-06-04T23:59:59+05:30"
                                        ]
                                    },
                                    {
                                        "field": {
                                            "api_name": "module"
                                        },
                                        "comparator": "in",
                                        "value": [
                                            {
                                                "api_name": "Calls",
                                                "id": "5725767000000033015"
                                            },
                                            {
                                                "api_name": "Events",
                                                "id": "5725767000000002195"
                                            },
                                            {
                                                "api_name": "Tasks",
                                                "id": "5725767000000002193"
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    ]
}
The above input schedules a job to export data that matches the criteria. The response to the above request is given below, and we will discuss how to see the status of the export audit log job and how to download the result in the upcoming sections in this post.

Refer to the Input JSON Keys to Export Audit Log Using Multiple Filters for input keys' explanations.

Note: 
With filters (either single or multiple criteria), you can export up to 6 months (180 days) of audit log data. Note that the time range should not exceed 180 days. 

Sample Response:

{
    "audit_log_export": [
        {
            "status": "success",
            "code": "SCHEDULED",
            "message": "ExportAuditlog scheduled successfully.",
            "details": {
                "id": "5725767000003525045" //unique job ID of the export audit log job.
            }
        }
    ]
}


The manager has scheduled an export audit log job to review their trainees' activities within the specified time range (six months).

Get the Status of the Export Audit Log Job

The manager at Zylker retrieves the details of the export audit log jobs that were scheduled previously using the POST Export Audit Log API.
  • Exporting All Trainees' Activities: By reviewing the complete log, the manager can analyze the overall performance of all trainees.
  • Filtering Specific trainees' Activities: Once after reviewing the entire log, the manager could filter data of only those trainees with average performance and provide them with the required training to help them improve.
Zylker retrieves the status of all scheduled export audit log jobs using the following URL: 

{api-domain}/crm/{version}/settings/audit_log_export

By default, it returns all the scheduled export jobs.

For retrieving the status of a specific scheduled export audit log job, Zylker uses the following URL:

{api-domain}/crm/{version}/settings/audit_log_export/{export_job_id}

Request Method: GET

Scope:  ZohoCRM.settings.audit_logs.READ 

Here is the sample response showing the status of the export audit log job for all the trainees:

{
    "audit_log_export": [
        {
            "id": "5725767000003525048",
            "status": "finished",
            "job_start_time": "2024-08-07T12:12:39-07:00",
            "job_end_time": "2024-08-07T12:12:44-07:00",
            "expiry_date": "2024-08-14T12:12:39-07:00",
            "created_by": {
                "name": "Jim", //Zylker's Manager
                "id": "5725767000000411001"
            },
            "criteria": {
                "group_operator": "and",
                "group": [
                    {
                        "comparator": "between",
                        "field": {
                            "api_name": "audited_time"
                        },
                        "value": [
                            "2024-01-05T00:00:00+05:30",
                            "2024-06-04T23:59:59+05:30"
                        ]
                    },
                    {
                        "comparator": "in",
                        "field": {
                            "api_name": "module"
                        },
                        "value": [
                            {
                                "api_name": "Tasks",
                                "id": "5725767000000002193"
                            },
                            {
                                "api_name": "Events",
                                "id": "5725767000000002195"
                            },
                            {
                                "api_name": "Calls",
                                "id": "5725767000000033015"
                            }
                        ]
                    }
                ]
            },
            "download_links": [
            ]
        }
    ]
}


Response JSON Keys explanation: 
  • audit_log_export (JSON array) : Contains the details for the audit log export request of the trainees.
  • id (string) : Represents the unique job ID of the export audit log job.
  • status (string) : Represents the status of the export audit log job. Possible values: Progress, Scheduled, Finished, and Failed.
  • job_start_time (string) : Represents the time at which the export job started.
  • job_end_time (string) : Represents when the export job was completed.
  • expiry_date (string) : Represents the expiry time of the exported audit log available in the download links.
  • created_by (JSON object) : Represents the ID and Name of the Zoho CRM user who initiated the export job.
  • criteria (JSON object) : Represents the conditions specified for a specific export audit log job using the Create Export Audit Log API.
  • download_links (JSON array) : Represents the unique downloadable link for the exported audit log. You can use this link to download the log data using the GET - Download Export Audit Log Result API. 

Download Export Audit Log Result

The manager at Zylker can download the result logs using the the "download_links" JSON array key in the response Get the Status of the Export Audit Log Job API.

An export audit log will be in either CSV or ZIP format, depending on the number of entries in the result. If the audit log contains 100,000 or fewer entries, the system will automatically export the logs in a CSV file. If there are more than 100,000 entries, the logs will be split into multiple CSV files inside a ZIP file, with each CSV file holding up to 100,000 entries. A maximum of 10,00,000 audit entries will be exported in a ZIP file.

Request Method: GET 

Scope: ZohoFiles.files.READ

In our case, download the audit log result in the CSV file format. 
Based on the downloaded results, the manager will analyze the trainees' performance to make hiring decisions and identify areas where those with average performance may need additional training. This approach helps the manager at Zylker to keep track of all trainees' activities regularly.

We trust that this post meets your needs and is helpful. Let us know your thoughts in the comment  or reach out to us at support@zohocrm.com
Stay tuned for more insights in our upcoming Kaizen posts!







    • Recent Topics

    • Field authorization for Linking module in Zoho CRM portal

      Hi guys! Currently building a customer portal for one of my clients, and I ran into a bit of a roadblock while using a multi-select lookup field. The issue is that there is no way to hide or define access in the linking module created by this multi-select

    • Kaizen #63 - Layout Rules in Zoho CRM

      Hello and welcome to another week of Kaizen! This week, we will be discussing Layout Rules in Zoho CRM. If you need to modify the layout of a module based on user inputs, or to show or hide sections based on the value of a specific field, we have got

    • Zoho CRM Portals - allow access per account

      Hello all, I am trying to set up a portal for our customer but I seem to be hitting an obstacle and I am not sure if it is my problem or a limitation in the software. So basically the way I understand the portal Contact Email > Each Record or Related

    • Android - Writer não acentua em Português com teclado bluetooth

      Gosto muito do Zoho, tanto o Note quando o Writer. Infelizmente, o Writer sofre de um problema sério: ao usar um teclado bluetooth, forma mais cômoda de lidar com um processador de texto, os acentos (todos!) da Língua Portuguesa não são aceitos. Todos

    • Set File Upload fields as mandatory

      Currently the CRM for some reason lacks the ability to set a file upload field as mandatory So we have an issue We have a requirement that before a Deal stage is set as Deal is Won the member needs to upload a file Now for some weird reason in Zoho I

    • Editing HTML in Zoho CRM Email Template

      I am trying to create a template within the CRM email option, but need to be able to use custom HTML. There does not seem to be a way to do so.

    • Ability to CC on a mass email

      Ability to CC someone on a mass email.

    • How to make attachments mandatory

      I want the user to be unable to mark an opportunity as Closed – Won if it doesn’t have any attachments. I’ve already tried client scripts and functions, but nothing worked.

    • SLA Ticket Report

      From data to decisions: A deep dive into ticketing system reports Service level agreement (SLA) ticket reports in a help desk system are crucial for ensuring that services are delivered according to established commitments. They help maintain accountability

    • Zoho Backstage - PCI Compliance / Web Security

      I have a couple of questions related to Backstage and payment processing.... 1. my purchasing division is not giving approval to use Backstage yet because of some security issues. In order for us to take payments via a payment gateway like Authorize.net

    • Zoho Tables August 2025 Update: Faster and Smoother

      We’ve been working behind the scenes to make Zoho Tables faster, lighter, and more reliable. Here are the highlights: Faster Response Times Optimised the way responses are generated. Reduced memory consumption by 20–25%, leading to smoother performance

    • Video Upload from app says "unsupported aspect ratio" but is verified to be correct.

      I and my social media person are experiencing a problem where Social will not accept video uploads to Instagram. The error we receive is "unsupported aspect ratio" but looking directly at the file in question we see that the width and ratio both match

    • Disposable Email Addresses

      Dear zMail Team, Can you also bring out a few disposable email addresses for each accounts? That way occasional registrations and imminent spam from them can be largely solved right? ---- Deepak Vasudevan http://thamizhththendral.blogspot.com/

    • Zoho sheet - Zoho expense

      I want to schedule to create an expense using Zoho Sheet and flow. That is the EMI that I pay on a particular date to the bank and should be itemised, like principal and interest on the loan. Can someone help me in this regard??

    • Ability to configure a schedule/shift for each user and/or crew in Zoho FSM

      Hello, In our team of Field Agents, we have different shifts. Some field agent always work from 7:00 AM to 4:00 PM while others work the evening shift like 4:00 PM to 11:00 PM. Sometime shift are on weekdays only or on weekend. It would be great to be

    • Free webinar: Streamlining customer service paperwork with the Zoho Sign extension for Zoho Desk

      Hello Everyone! Have you been wondering about bridging the gap between digitised customer service and business paperwork? Join our free webinar to learn how you can do this by connecting Zoho Sign, our digital signature app, with Zoho Desk, our online

    • Zoho Books | Product updates | July 2025

      Hello users, We’ve rolled out new features and enhancements in Zoho Books. From plan-based trials to the option to mark PDF templates as inactive, explore the updates designed to enhance your bookkeeping experience. Introducing Plan Based Trials in Zoho

    • Mail Search should allow grouping by conversation like Gmail.

      Having switched from gmail I have found the search function hard to use. Mostly because mail is not grouped by conversation in search. If I search for a word when looking for a conversation had with someone then sometimes 10 emails will come up from the

    • Improve Zoho Learn updated article notifications

      I noticed today while updating an article, that the notification users get says "[User Name] has published article [Article Name]..." My feedback to the product team is that it would be really helpful for an end user, if the system notification differentiated

    • Safari Support

      Safari, the world's second largest browser, zoho desk does not officially or fully support. That needs to change.

    • Can I get images from an "Image Upload" field in a webhook?

      I want to send images from 2 "image upload" fields via a webhook. Is this possible?

    • Ticket closure notification - all contacts cc'd on email thread

      Hello, If a client sends an email to our service desk and cc's in other people that work at the same company - so that they are in the loop of the service request. When the we close the ticket, only the ticket owner (person who emailed us - which created

    • Inactive account cleanup policy for Zoho Sign

      Zoho Sign reserves the right to delete accounts that are license free and inactive for more than 120 days. The account deletion will be initiated only after the user receives prior email notice about possible data deletion and how to backup the data.

    • Missde API documentation for Sales Receipt

      Hi! I noticed that the Sales Receipt endpoint is not currently listed in your API documentation (https://www.zoho.com/books/api/v3/introduction/). Could you please provide any available temporary documentation for this endpoint, along with a detailed

    • Multi-currency in Zoho CRM Forecast and Reports

      As a company we have branches in 4 different countries with as many different currencies. Our Sales Teams would like to work with their local currency as much as possible. The Forecast module using only 1 currency is practically usable only by the sales

    • How to select from pricebook when creating a salesorder or quote

      I am creating a sales order and when selecting the Products I do not see any where to select from pricebooks. How do i associate this to my orders?

    • Proposal for Creating a Unique "Address" Entity in Zoho FSM

      The "Address" entity is one of the most critical components for a service-oriented company. While homeowners may change and servicing companies may vary, the address itself remains constant. This constancy is essential for subsequent services, as it provides

    • I cannot find my older documents from 2024 and 2023

      I cannot find my older documents from 2024 and 2023.

    • System default SLA descriptions can't be modified

      The system default SLAs have identical descriptions for all SLA levels, but their settings differ. However, I am facing an issue where I cannot modify these descriptions and save the changes. The content of the description box can be edited but the changes

    • Customising Help Center

      Hi I don't think it is possible to add custom pages to help center? We'd like to use this as a customer portal with support tickets, FAQ/Guides, Billing and contracts. Is there any plans to add a feature like this or an alternative way to do it other

    • Replies sometimes creating separate ticket

      Sometimes when a customer responds to an email coming from Zoho Desk, instead of adding a reply to the original ticket, a separate ticket is created. This happens even though the response subject line contained the ticket number, and the person responding

    • Ticket Approvals - External Users

      The ticket approval option - we need to be able to select external users (Contacts) for approvals. Sometimes we are working with an end user and their boss needs to approve a purchase. For example, working with a cashier on a broken cash register and

    • Force Users to Ask Answer Bot a question... First

      End users will always skip talking to a bot. It would be nice if Zoho adopted the standard and forced users to first ask a question to answer bot (or zia in some fashion) and then pass to the agent if it wasn't answered. Options to force the user to speak

    • View Answer Bot conversations?

      We are trialing Zia and are experimenting with Answer Bot on our knowledge base. So far so good! Management asks me if it is possible to view Answer Bot conversations, the purpose being to look over its shoulder and confirm that it is working as des

    • Mass Email an Account

      It would be nice to mass email an account stating there is an outage at their business or something specific to an account is needed to be mass communicated. Even if it makes a ticket for every Email Out to every contact in the Account. Think: the customer

    • Multiple Topics assigned to a single Campaign

      Hello, is it possible to assign multiple Topics to a single Campaign? We frequently write a content to our subscribers that spans multiple Topics and we would like to send it to all Contacts that are subscribed to at least one of the Topics. But it looks

    • Zoho Projects Fonts and Accessibility missing

      I cannot find any more the tab where I can change the font in Zoho Project. I also checked the knowledgebase and there they have accessibility tab which I am completely missing. Is there some setup I am missing or is it a problem with our account?

    • Zoho Books Custom Widgets Deprecation Error

      I created a simple sample widget with zet and published it using sigma Both in the Sandbox and Production the Widgets are showing this error

    • Problems with PDF files in notebook

      I'm evaluating Zoho Notebook as an alternative to Evernote and imported my Evernote account to Zoho Notebook. First issue is that notes in Evernote that comprise a PDF are turned into a 'group' with a single note page (that has the text from the Evernote

    • API (v3) Tasks sorting issue

      We are using the v3 API for Projects. When we gat all tasks, per page of 100 tasks, we get the task info alright. But when we try to sort based on DESC(last_modified_time) we don't get the correct sort order. It is roughly sorted by the last_modified_time,

    • Next Page