Zoho: Create an audit log export job

Zoho auditLogExport.createAuditLogExport: arguments, response, policy and SDK examples.

← Audit log export operations · Get started

Operation zoho.createauditlogexport

Provider route: POST /crm/v8/settings/audit_log_export. 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"]["createAuditLogExport"]>[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.createAuditLogExport(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.create_audit_log_export(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`body`	object	Optional	Represents the request body for creating an audit log export job. Additional keys: not allowed
`body.audit_log_export`	array	Required within parent	Specify the list of audit log export job configurations. Maximum items: 100
`body.audit_log_export[]`	object	Each item	Specify the details for each audit log export job, including the filter criteria. Additional keys: not allowed
`body.audit_log_export[].criteria`	Model	Required within parent	Expand Create an audit log export job — request body — body audit log export item criteria

Referenced models: Create an audit log export job — request body — body audit log export item criteria

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
`$`	object	Root	Represents the success response for creating an audit log export job. Additional keys: not allowed
`audit_log_export`	array	Optional	Represents the list of audit log export job responses. Maximum items: 1
`audit_log_export[]`	object	Each item	Represents the response details of a single audit log export job. Additional keys: not allowed
`audit_log_export[].code`	string	Optional	Specifies the status code of the export job creation. Possible values: SCHEDULED - The audit log export job has been successfully scheduled. Known values: SCHEDULED
`audit_log_export[].details`	object	Optional	Represents additional details for the scheduled audit log export job. Additional keys: not allowed
`audit_log_export[].details.id`	string	Optional	Represents the unique ID of the scheduled audit log export job. Maximum length: 64
`audit_log_export[].message`	string	Optional	Represents the message describing the audit log export job status. Maximum length: 256
`audit_log_export[].status`	string	Optional	Represents the status of the export job creation request. Possible values: success - The audit log export job creation completed successfully. Known values: success

Schemas

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

Create an audit log export job — request body — body audit log export item criteria

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

Referenced models: Create an audit log export job — request body — body / audit_log_export / item / criteria / group_operator: and, Create an audit log export job — request body — body audit log export item criteria A single field-level filter condition

Create an audit log export job — request body — body / audit_log_export / item / criteria / 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 Create an audit log export job — request body — body audit log export item criteria A single field-level filter condition
`group[] (anyOf 2)`	Model	Alternative	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / group_operator: and
`group_operator`	string	Required within parent	Logical operator applied between the grouped conditions. One of: and

Create an audit log export job — request body — body audit log export item criteria 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 Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal, value: added, updated, deleted
`$ (anyOf 2)`	Model	Alternative	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Action In Criterion
`$ (anyOf 3)`	Model	Alternative	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal — Audit Log Module Equal Criterion
`$ (anyOf 4)`	Model	Alternative	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Module In Criterion
`$ (anyOf 5)`	Model	Alternative	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion
`$ (anyOf 6)`	Model	Alternative	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in — Audit Log Done By In Criterion
`$ (anyOf 7)`	Model	Alternative	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: between

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

Create an audit log export job — request body — body / audit_log_export / item / criteria / 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. One of: 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. One of: action
`value`	string	Required within parent	Action to match. One of: added, updated, deleted

Create an audit log export job — request body — body / audit_log_export / item / criteria / 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. One of: 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. One of: action
`value`	array	Required within parent	Actions to match. Maximum items: 3 Minimum items: 1
`value[]`	string	Each item	Action to match. One of: added, updated, deleted

Create an audit log export job — request body — body / audit_log_export / item / criteria / 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. One of: 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. One of: 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

Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: equal — Audit Log Done By Equal Criterion

Field	Type	Presence	Description and constraints
`$`	object	Root	Match audit log entries performed by a single user. Additional keys: not allowed
`comparator`	string	Required within parent	Comparison operator. One of: 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. One of: done_by
`value`	array	Required within parent	Exactly one user reference. Maximum items: 1 Minimum items: 1
`value[]`	Model	Each item	Expand Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value

Referenced models: Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value

Create an audit log export job — request body — body / audit_log_export / item / criteria / A single field-level filter condition / comparator: in value item — Audit Log Done By Value

Field	Type	Presence	Description and constraints
`$`	object	Root	User reference for the done_by filter. Additional keys: not allowed
`id`	string	Required within parent	Unique identifier of the user. Maximum length: 64
`name`	string	Optional	Display name of the user. Maximum length: 256

Policy, approvals and errors

SDK function policy ID: zoho.createauditlogexport. Catalog operation: createAuditLogExport. 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.

Official provider source

Report an issue with this page