Zoho: Get the Status of the Export Audit Log Job

← Audit log export operations · Get started

Operation zoho.getauditlogexportsbyid

Provider route: GET /crm/v8/settings/audit_log_export/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["auditLogExport"]["getAuditLogExportsById"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.auditLogExport.getAuditLogExportsById(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.audit_log_export.get_audit_log_exports_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 64

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the success response for retrieving an audit log export job by ID. Additional keys: not allowed
$ (anyOf 1).audit_log_export	array	Optional	Represents the list containing the requested audit log export job. Maximum items: 100
$ (anyOf 1).audit_log_export[]	object	Each item	Represents the details of the specified audit log export job. Additional keys: not allowed
$ (anyOf 1).audit_log_export[].created_by	object	Optional	Represents the Zoho CRM user who created the export job. Additional keys: not allowed
$ (anyOf 1).audit_log_export[].created_by.id	string	Required within parent	Represents the unique ID of the user who created the export job. Maximum length: 64
$ (anyOf 1).audit_log_export[].created_by.name	string	Optional	Represents the name of the user who created the export job. Maximum length: 256
$ (anyOf 1).audit_log_export[].criteria	Model	Required within parent	Expand Get audit log export jobs — response body — audit log export audit log export item criteria
$ (anyOf 1).audit_log_export[].download_links	JSON	Required within parent
$ (anyOf 1).audit_log_export[].download_links (anyOf 1)	array	Alternative	Download links for exported audit logs. Null until the job completes and produces at least one file. Maximum items: 1000
$ (anyOf 1).audit_log_export[].download_links (anyOf 1)[]	string	Each item	Represents a URL for downloading the exported audit log result. Maximum length: 2048
$ (anyOf 1).audit_log_export[].download_links (anyOf 2)	null	Alternative	Download links for exported audit logs. Null until the job completes and produces at least one file. Maximum items: 1000
$ (anyOf 1).audit_log_export[].download_links (anyOf 2)[]	string	Each item	Represents a URL for downloading the exported audit log result. Maximum length: 2048
$ (anyOf 1).audit_log_export[].expiry_date	JSON	Optional
$ (anyOf 1).audit_log_export[].expiry_date (anyOf 1)	string	Alternative	Expiry date for download links. Null until download links are generated. Format: date-time
$ (anyOf 1).audit_log_export[].expiry_date (anyOf 2)	null	Alternative	Expiry date for download links. Null until download links are generated. Format: date-time
$ (anyOf 1).audit_log_export[].id	string	Optional	Represents the unique ID of the audit log export job. Maximum length: 64
$ (anyOf 1).audit_log_export[].job_end_time	string	Optional	Represents the date and time when the export job was completed. Format: date-time
$ (anyOf 1).audit_log_export[].job_start_time	string	Optional	Represents the date and time when the export job started. Format: date-time
$ (anyOf 1).audit_log_export[].status	string	Optional	Status of the export job. Known values: queued, scheduled, running, suspended, failed, finished, deleted
$ (anyOf 2)	null	Alternative

Referenced models: Get audit log export jobs — response body — audit log export audit log export item criteria

Schemas

6 more schemas are linked from the tables above, on the schema pages.

Get audit log export jobs — response body — audit log export audit log export item criteria

Field	Type	Presence	Description and constraints
$	JSON	Root	Filter criteria stored for this export job. Null when the job was created without criteria.
$ (anyOf 1)	Model	Alternative	Expand Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job
$ (anyOf 2)	null	Alternative	No criteria were stored for this export job.

Referenced models: Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job

Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job

Field	Type	Presence	Description and constraints
$	JSON	Root	Filter criteria for an audit log export job.
$ (anyOf 1)	Model	Alternative	Expand Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition
$ (anyOf 2)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and

Referenced models: Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and, Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition

Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and

Field	Type	Presence	Description and constraints
$	object	Root	A group of filter conditions combined with a logical operator. Additional keys: not allowed
group	array	Required within parent	Conditions to combine. Maximum items: 2 Minimum items: 1
group[]	JSON	Each item	A condition within the group.
group[] (anyOf 1)	Model	Alternative	Expand Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition
group[] (anyOf 2)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and
group_operator	string	Required within parent	Logical operator applied between the grouped conditions. Known values: and

Referenced models: Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / group_operator: and, Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition

Get audit log export jobs — response body — audit log export audit log export item criteria Filter criteria for an audit log export job A single field-level filter condition

Field	Type	Presence	Description and constraints
$	JSON	Root	A single field-level filter condition.
$ (anyOf 1)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal, value: added, updated, deleted
$ (anyOf 2)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Action In Criterion
$ (anyOf 3)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Module Equal Criterion
$ (anyOf 4)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Module In Criterion
$ (anyOf 5)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion
$ (anyOf 6)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Done By In Criterion
$ (anyOf 7)	Model	Alternative	Expand Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: between

Referenced models: Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal, value: added, updated, deleted, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Action In Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: between, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Done By In Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal — Audit Log Module Equal Criterion, Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Module In Criterion

Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: equal, value: added, updated, deleted

Field	Type	Presence	Description and constraints
$	object	Root	Match audit log entries whose action equals a single value. Additional keys: not allowed
comparator	string	Required within parent	Comparison operator. Known values: equal
field	object	Required within parent	Field to apply the filter on. Additional keys: not allowed
field.api_name	string	Required within parent	API name of the field. Known values: action
value	string	Required within parent	Action to match. Known values: added, updated, deleted

Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: in — Audit Log Action In Criterion

Field	Type	Presence	Description and constraints
$	object	Root	Match audit log entries whose action is one of several values. Additional keys: not allowed
comparator	string	Required within parent	Comparison operator. Known values: in
field	object	Required within parent	Field to apply the filter on. Additional keys: not allowed
field.api_name	string	Required within parent	API name of the field. Known values: action
value	array	Required within parent	Actions to match. Maximum items: 3 Minimum items: 1
value[]	string	Each item	Action to match. Known values: added, updated, deleted

Get audit log export jobs — response body — audit_log_export / audit_log_export / item / criteria / Filter criteria for an audit log export job / A single field-level filter condition / comparator: between

Field	Type	Presence	Description and constraints
$	object	Root	Match audit log entries audited within a time range. The range must not exceed 180 days. Additional keys: not allowed
comparator	string	Required within parent	Comparison operator. Known values: between
field	object	Required within parent	Field to apply the filter on. Additional keys: not allowed
field.api_name	string	Required within parent	API name of the field. Known values: audited_time
value	array	Required within parent	Start and end of the range, as exactly two ISO 8601 timestamps. Maximum items: 2 Minimum items: 2
value[]	string	Each item	An ISO 8601 timestamp. Format: date-time

Policy, approvals and errors

SDK function policy ID: zoho.getauditlogexportsbyid. Catalog operation: getAuditLogExportsById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source