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!
- Previous Kaizen Post: Kaizen #149 : Using GraphQL APIs to fetch data in a consolidated way
- Further Readings:
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Subramanian K
Sticky Posts
Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Adding Markdown text using Zoho Desk API into the Knowledge Base
Hi Zoho Community members, We currently maintain the documentation of out company in its website. This documentation is written in markdown text format and we would like to add it in Zoho Knowledge Base. Do you know if there is REST API functionalityCreate case via email
Good Afternoon, I have just registered and am taking a look around the system. Is it possible to create a case via email. I.e. an employee/client/supplier emails a certain address and that auto generates the case which then prompts a member of staffNeed a Universal Search Option in Zohobooks
Hello Zoho, Need a Universal Search Option in Zohobooks to search across all transactions in our books of accounts. Please do the needful ThanksLocked Notebook
Hi, I hadn't used my Notebook in some time and was refamiliarizing myself with it. I clicked a lock icon and now I can't unlock. When I hit the information or unlock icons I'm taken to a page with the notebook icon and a keyboard. When I type, nothingHide fields only for creation
Hello, I'd like to hide some fields only during the creation of a contact in Zoho CRM. In fact I have some fields that are automatically calculated thanks to an automation, so when my users create a contact I don't want them to fill those fields. I knowIssues with Zoho Sheet in Mac
I have downloaded the Zoho App from App Store but It is failing to Save As, Open & Download Operations. App StoreWeekly Sales Summary
Is it possible to generate a weekly report in Zoho Books to show -$$ amount of estimates generated -# of estimates generated by Salesperson -$$ amount of Sales Orders created -$$ amount of Invoices generatedOpenAPI Specs are just plain wrong
The provided yml files for generating the OpenAPI specs are absolutely riddled with errors and inconsistencies. From missing fields on the objects, to just incorrectly named resource objects. I'm having to go through and manually changing the spec toAdd Account column to Invoice screen
Please show the account column on Invoice creation screen. It is an unnecessary step to have to click add additional info and then select the account for line item. Example : on the bill creation screen when entering description we can easily code it against an account. On the invoice screen it requires additional click. Adding the column on the Invoice screen will make it faster to enter transactions. We currently have 5-6 different accounts that we code line items against, You can imagine the extraCustom Footer – Zoho Writer Document
Hello everyone, I’m having an issue adding a custom footer in a Zoho Writer document. I would like to insert my company information (including a logo + address) in the footer. The problem is that when I add these elements, the main content of my pagesReport grouping
I have added a grouping in a report but it is not working how i had expected. I wanted to group a summary on a field named Size but when i add the grouping the report is still showing me each record and making a summary at the bottom of the report. WhatSocial Media Simplified with Zoho Social: Preview your Instagram grid before posting
For a platform like Instagram that relies on visual appeal, it's important that you plan your image and video content in a way that holds your audience's attention. Planning your grid ahead of time gives you the benefit of understanding how your postsError code 1000
Can you please tell me why the following, occasionally causes this error via the api, not every time ?... zoho.books.updateRecord("salesorders",organizationID,salesorderID,{"template_id":"#################069","custom_fields":[{"label":"DelDate","value":"Tuesday,VAT rates - exempt and out of scope
Good Evening, UK based company here. I am a bit confused in respect of setting up VAT rates for exempt goods and services; at present I am simply leaving the VAT rate blank in the transactions in order to prevent any VAT appearing in the VAT return. WhenHow to loop through Multiple Upload and Display Actual File Name
I have been reading the help on the File Upload Control and reviewed the Deluge help on files and I can not figure out how to loop through the uploaded files and do anything but get the automatically created file names. The code below will run but eachabou arattai
I want to use the Arattai app for business purposes, so please convert my account to a business account.I have my own invoice app, and I want to link it with the Arattai app for direct messaging.Configurable Zoho Cliq Notifications for Zoho People Alerts
Hello Zoho People Product Team, Greetings and hope you are doing well. We would like to request an enhancement to Zoho People notifications, enabling a native delivery via Zoho Cliq with admin-level control, similar to the notification settings availableLooking back at Zoho Calendar in 2025
Hello Zoho Calendar Community, As we step into a brand-new year, we’d like to take a moment to thank you for being an active and valued part of the Zoho Calendar community. Your trust, feedback, and continued engagement motivate us to keep evolving andThere was an error while connecting to GSTN
I am trying to file GSTR1. Everything flows smoothly until I reach the final step of filing the return. After I enter the PAN and OTP for filing it raises the error "There was an error while connecting to GSTN"Zoho Books Extension: What Happens If Custom Fields Already Exist?
When developing Zoho Books extensions, what happens if the target Zoho Books organization already has a custom field with the same API name as one defined in the extension? I’m asking because we originally created an on-Books version of this functionality,Internal Server Error (500) When Attempting to View Banking Transactions
I am experiencing an Internal Server Error (500) when attempting to view transactions across all of my banking accounts. Despite multiple attempts to resolve this, I have received little more than runaround from support, and the issue remains unresolved.How do I add a blank line to the Organisation Address Format?
I'd like to have my VAT number, for example, shown prominently by having a clear gap between it and the address block above, but any blank lines in the address format get ignored in PDF outputs.Automatic Invoice Number generation for createRecord
Hello, while testing some custom Buttons in my Zoho Books application, I noticed that I get an error that previously did not occur. After some further digging I found that the automatic transaction numbering of invoices no longer work in my organization.Adding number of days to an estimate.
I need both QTY of item and "number of days hire" in my estimates at the line item level. Any clues as to how this is done would be greatly appreciated. It needs to calculate. Thanks JBooks Api: listing expenses created after certain dates
Is there any parameter I can add to the List Expenses endpoint that will let me look up expenses by when they were created?Why can't we change the Account type from an Expense to an Asset?
Like the question. Why in QuickBooks for example if I mistakenly created an account as an expenses and I already captured information in those accounts, I can just change the account type from expense to assetIs it possible to do validation for the Actions added to Reports?
We have an all-around On Validate function that checks all the possibilities before the Created/Edited form submissions. We want to have a button in the report view, so we can change records without entering. We are able to add this button, and it does[Free Webinar] Environments in Zoho Creator - Creator Tech Connect
Hello Everyone, We’re delighted to kick off the 2026 edition of the Zoho Creator Tech Connect Series and are excited to continue this learning journey with you. The Creator Tech Connect series is a free monthly webinar featuring deep-dive technical sessionsZoho Voice API SMS
I made a post request in Zapier to try to send an SMS. Authentication appears to be configured correctly. I followed the documentation and I'm getting a 400 Error "Internal Server Error". Not helpful at all. Anyways, I could not find any information onHow do I change (error) display messages
Hi! I would like to edit display messages like "invalid entries" and "enter a value for Nome" and so on into Italian language messages. How can I do that? Already tried on Validate on form submit. Where I am failing? Thanks in advance.Record Overseas Transactions Along with CC charges
Hi All, We receive payments via stripe in multiple currencies and stripe takes around 2.5% fees. The amount is settled in INR into our local bank. What should be the currency of the income account used for Stripe payments? Here is a sample flow that weEasier onboarding for new users with stage descriptions
Greetings, I hope all of you are doing well. We're happy to announce a recent enhancement we've made to Bigin. You can now add descriptions to the stages in your pipeline. Previously, when creating a pipeline, you could only add stages. With this update,Pieds de page personnalisé - Document Zoho Writer
Bonjour à tous, Je rencontre un souci avec l’ajout d’un pied de page personnalisé dans un document Zoho Writer. Je souhaite insérer les informations de mon entreprise (notamment un logo + adresse) dans le pied de page. Le problème, c’est que lorsque j’ajouteCredit card transactions are backwards after importing statements
I am new to Zoho Books so I'm importing my firm's bank and credit card statements in. My credit card statements have a single column with negative numbers so that is the option I chose. But when I went to categorize the credit card transactions, I canPermissions on Views
Having the option of any agent creating custom views is firing back and got a situation where there are a hundred different views across the team and tickets are not being dealt in the most efficient of ways. Tickets seems to be missed by some agents,Function #8: Add additional charges to invoices
Here goes one of the highly sought-after custom functions in Zoho Books. If you find yourself needing to apply additional charges to customers on their invoices (say credit card surcharges, or fuel charges applicable to customers from a certain region,VIsual maindmaps in Zoho notebook Ai
Can I create and export VIsual maindmaps in Zoho notebook Ai1stDibs Integration to Zoho Inventory
Hello is it possible to integrate my Zoho inventory and 1stDibs?Community Question: Renewal vs Invoicing
This is a question for the community. Does anyone else consider there to be a difference between a subscription renewal event and sending out a recurring invoice for a subscription? For example, let's say customer XYZ purchases a 1-year subscription tocloud console support for music websites
Hi Friends, I am not from a very technical background.. So need support from the Zoho family. I want to build a e-commerce website which is in Musical Niche. It will help people learn music & play instruments of all types. There are a few players in the market like Chordify , Guitaa, Guitar Dashboard, ChordU & few others. But I all these websites allow only a few instruments to play. So I want to build a better website than the one I mentioned. So wnated to know what UI & AI should I use so thatNext Page