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
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
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
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
How to add a customized/dynamic Zoho Booking link in email footer?
We just installed the latest version of the Zoho Desk <=> Zoho Booking extension from the marketplace and are quite happy to see the feature where a ticket-specific appointment booking link can be inserted in a reply. Is there any way to configure thisZOHO BOOKS EXPERT
We are planning to migrate from Quick Books to Zoho Books, and are looking for a professional with experience in migration to Zoho Books and the setup of Zoho Books. Currently, we have two companies and two Quick Books accounts, and we want to integrateAdd export option that only export one or selected notebooks
Currently the export function will export ALL data every time, this not only wastes user bandwidth, disk I/O and local storage space, but also consumes more resources on the server. Partial export should be a very basic and easy-to-implement feature.Power of Automation :: Design your Ideal Task form with Task Layout Rules.
Hello Everyone, Use case:- One of our customers, who is managing their entire workflow in Zoho Projects wanted to dynamically display task fields based on the type of task being created. For instance, if a task falls under the "Shipment" category, onlyMaster account and move under member account How do I do it?
I have a master account with a customer on which the customer has 4 sales points located in different places around them that I would like to add to my Master account under the member account but I can't figure out how to add them since they are currentlyCreating a whatsapp channel in instant messaging in zoho desk - error Oops, something went wrong. Please try again later.
Creating a whatsapp channel in instant messaging in zoho desk - error Oops, something went wrong. Please try again later.Quoted item subform setup button missing to add back unused field. (Zoho CRM professional edition)
With Zoho CRM professional edition, understand that we couldnt further customize subform. But i notice there is no setup button for me to add back unused field that i accidentally removed (Tax field). it doesn't appear on left panel unused field as well.Updating Zoho Multi-Select Lookup via Deluge Script
I need to copy the ID of a lookup field (Match_with_IP) in the to the ID of a multi-select lookup field in the contact (Match_with_IP). I have the following script: record = zoho.crm.getRecordById("Contacts",ID); M_record = zoho.crm.searchRecords("Deals","(Matched_with_GC:equals:"Cliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsOpen a popup window from inside Record A and stay on the record after saving Record B
Hello community, Perhaps you can help me with the following topic. I have a form A with a decision box. When this decision box is checked, a form B pops up. Once Form B is saved, I need to stay on Form A to continue entering data. I've observed the followingEnhancements in Canvas
Dear All, Greetings! Canvas lets you design the record details page to suit your brand or business preferences. We are glad to introduce the following enhancements to uplift your design experience. Reusable Components Style Presets Let's go! ReusableNow filter your records by multi-select pick list values from a dropdown with additional operators
Hi everyone, Here's an update to help you elevate your filtering experience. You can now say goodbye to the cumbersome string values in filtering places for your multi-select picklist fields and say hello to a dropdown interface. It is now possible forCross-Data Center Collaboration and / Or allowing users to choose DC
Dear Zoho Cliq Support Team, We are writing to request a significant enhancement to Zoho Cliq that would greatly benefit our geographically dispersed development team. Current Challenge: Currently, Zoho Cliq automatically routes users to specific dataSolicitud revisión y desbloqueo correos de el dominio ecuatoys.com.ec
Hola equipo de Zoho, Mi cuenta de correo asociada al dominio ecuatoys.com.ec está bloqueada para el envío de correos (Error 554 5.1.8 Email Outgoing Blocked). Quisiera solicitar su revisión y desbloqueo. Ya tengo correctamente configurados los registrosMS Teams for daily call operations
Hello all, Our most anticipated and crucial update is finally here! Organizations using Microsoft Teams phone system can now integrate it effectively with Zoho CRM for tasks like dialling numbers and logging calls. We are enhancing our MS Teams functionalityLog for Scheduled Reports
Hello, Is there somewhere to view a log of the successful and/or failed delivery of Scheduled Reports? We have users who only receive them sporadically instead of at the scheduled intervals and I'd like to understand what causes the problem when it occurs.How to get the call recording external ID via desk API
I have enabled phonbridge integration with Zoom Call. I am trying to access the call recording in Zoom by calling Zoom API. I have built a Desk workflow to trigger on a new call, to call a custom function. when calling the API, the response doesn't containNeed the ability to have read only fields on a form.
There needs to be functionality in Creator that allows a field on a form to be read only. Most screen building software applications have this capability. I know you can hide certain fields from specific users and that you can also make the whole form read only but that's not the functionality I need. I want to be able to create a form where certain fields are editable and other are for display purposes only (read only). For example if the form was displaying information on an item that the user【Zoho CRM】BCCメール取り込みのアップデート
ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 今回は「Zoho CRM アップデート情報」の中から BCCメール取り込み用メールアドレスの認証についてご紹介します。 ・既存のBCCメール取り込み用のメールアドレスは、2025年5月15日までに認証する必要がございます。 BCCメール取り込みは、さまざまなメールアドレスから送信されたメールをZoho CRMのレコードと同期させる機能です。 BCCメール取り込み用のメールアドレスをBCCに追加するだけで、該当のメールがレコードと関連付けされます。Sending Recruit SMS's to Zoho Cliq - Or tracking in the Messages module in Recruit?
Is there any way to send SMS Gateway messages in Recruit to ZOho Cliq? We use 2-way SMS massages a lot in Zoho Recruit to speed up communication with Candidates. However the only way to keep track of received SMS's is by keeping a look out for the EmailAdd timestamp when checkbox is checked in ZohoCRM
I have two fields. One is a checkbox field called "Check", one is a formula field called "Date" in my ZohoCRM Leads Module. I want the formula field to AUTOMATICALLY populate with the date when I check the box next to it. Can this be done?Customer Statement Templates
Hi In know that Credit Note Templates have already been proposed but I would also like to see Customer Statement templates as well please. Thanks GeneHTML Email in Zoho Books
Is it possible to create custom html email template in zoho books.Agents permission per department
Hi Team, can I setup permission for each agent what they can do in each department, for example I want account department agents to only have view access to support department tickets and not allowed to assign or reply to clients. I am sure this wouldDon't allow scheduling service on same day
Is there a way when setting up a Service for people to schedule to not allow them to schedule it for the same day, only a future date? We don't want people scheduling their meeting/service without giving us time to prepare for it.Presenting the brand new Zoho Bookings!
Hello everyone, Greetings from Zoho Bookings! We're happy to announce a new version of our product with enhanced features to simplify scheduling, coupled with a sleek interface and improved privacy across teams. Here's what you can expect from the latestExpense Entry Error When Trying To Save (Related To Taxes)
Hey folks, I've been trying to enter my first few expense entries in Zoho Books and I'm faced with the following error. "You cannot perform tax related operations when you are not registered for tax." But I have my HST/GST enabled and the tax rates areOnboarding Zoho sign documents?
I was wondering something about using the Zoho sign integration with the candidate onboarding process. We set up the entire onboarding process and we have added documents that the candidate needs to review and sign digitally using Zoho Sign. This partEmail Templates - Is There a Ticket Placeholder for Billing Entity ID
Was looking to add Billing Entity ID as a placeholder in a ZoHo email template. https://help.zoho.com/portal/en/kb/desk/customization/templates/articles/creating-and-managing-email-templates#Guide_to_Placeholders e.g. the placeholder for Account wouldIntegration with Woocommerce
Hi, Do you have plan to make integration with other e-commerce platforms, for example Woocommerce / Shopify / Magento ? Thanks.Se puede mover un Cliente de un modulo a otro personalizado
Hola, tengo una duda que me gustaría resolver: Actualmente trabajo con dos módulos: Seguimiento de Venta y Cierre de Ventas . Mi objetivo es que, cuando desde el módulo de Seguimiento se marca una venta como "Venta Efectiva" , el cliente sea movido alExport Data & Attachments
Hi, I am wondering whether it is possible to create an export of all data in creator, including attachments, for either backup purposes, or migration purposes. Thanks.Apply partial payments to invoices from the Banking Module
We need this! Why is this not possible?Zoho Desk: Q1 2025 | What's New
Hello everyone, Our first release for the year 2025 is here! Check out the Release Notes for more details The diverse capability of AI and its avatars has been the center of attention lately, and we've made some significant strides in this area. We nowFeature Request Improve parent-child relationship visibility
Hi team, The Parent-Child ticket feature is great, but I've struggled to see the relationship between tickets when using ticket list views. It would be a great quality of life enhancement for users if child tickets were nested under parent tickets inIssues with Dashboard Filter and KPI in Zoho Analytics (CAGR)
Hi everyone, I'm trying to build a CAGR (Compound Annual Growth Rate) KPI in Zoho Analytics, but I'm running into some issues with filter synchronization. Here's the scenario: I created two test reports: One that filters results from 2021 to 2025. Anotherneed a third party to fix email authentication dns records
at my wit's end - zoho began giving me spf, dmarc, dkim errors two weeks ago fussed with it since and now it seems dkim is the only problem and when i added the dkim record with the key from zoho mail it still wont work tired of this, need someone whoHow do i move multiple tickets to a different department?
Hello, i have several tickets that have been assigned to the wrong department. I am talking about hundreds of automatically generated ones that come from a separate system. How can i select them all at once to move them to another department in one go? I can select them in "unsassigned open tickets view" but i can't find a "move to another department" option. I also can't seem to assign multiple tickets to the same agent in that same view. Could somebody advice?Zoho Books Sandbox environment
Hello. Is there a free sandbox environment for the developers using Zoho Books API? I am working on the Zoho Books add-on and currently not ready to buy a premium service - maybe later when my add-on will start to bring money. Right now I just need aAdd Button on Tickets
is there a way I could add another button on the ticket aside of "closed ticket" only. Like I want to add another button "Send & Pending", "Pending for Response" like that.Next Page