Skip to navigation
MediationAudit Trail

Create a job to export audit trail data for a meter

View as Markdown

Creates a background job to export the audit trail entries for a specific meter in Zuora Mediation. This API is for large-scale, offline access to audit data. Only one export job is processed per tenant at a time, and each export has a record limit, for example, up to 5 million rows per report. Use the returned requestId with the “Retrieve the list of export jobs for a meter” API operation to track the job status and retrieve the generated file names from fileList, then download them using the “Retrieve the presigned URL for an export job” API operation.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

meterIdlongRequired
The ID of the meter.

Headers

Accept-EncodingstringOptional

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-IdsstringOptional

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Zuora-Track-IdstringOptional<=64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Query parameters

exportTypeenumRequired

Type of the export. SAMPLE indicates an export of success records, ERROR indicates an export of error records.

Allowed values:
runTypeenumRequired

Specifies the type of run. DEBUG indicates a test run, NORMAL indicates a live run.

Allowed values:
sessionIdslist of stringsOptional

A list of specific run IDs to export. For example, R-000001, R-000002.

runStatuseslist of stringsOptional

Filters audit entries by their run status. If omitted, all statuses are included. Statuses are case-sensitive. Possible values:

  • NEVER_RUN
  • TESTING
  • TESTING_FAILED
  • TESTING_PASSED
  • RUNNING
  • PAUSED
  • COMPLETED
  • FAILED
  • CANCELED
  • INITIALIZING
  • USAGE_PUSHING
  • PUSH_COMPLETED
  • CONSUME_COMPLETED
operatorIdslist of stringsOptional
A list of operator IDs to filter by. The Operator ID is displayed for each operator node, for both current meters and historic runs. On the Mediation UI, click on a test ID or session ID to see the details of the run.
queryFromTimestringRequired
The minimum timestamp for the data to be exported. The standard used is ISO 8601 with timezones.
queryToTimestringRequired
The maximum timestamp for the data to be exported. The standard used is ISO 8601 with timezones.
formatenumOptionalDefaults to csv

Required format for the exported data.

Supported values are:

  • csv: Row-based CSV output
  • parquet: Columnar Parquet output
  • avro: Avro output

If omitted, csv is used by default for backward compatibility.

Allowed values:
compressionenumOptionalDefaults to none

Optional compression algorithm applied to the exported file(s).

Supported values are:

  • none: No compression (default)
  • gzip: GZIP compression
  • lz4: LZ4 compression
  • zstd: Zstandard compression

If omitted, none is used and the export produces an uncompressed file. When a compression value other than none is specified, the generated export files are stored in compressed form and must be decompressed by the client after download.

Allowed values:

Response

OK
successbooleanOptional
Indicates whether the request was successful.
datamap from strings to objectsOptional
List of audit trail entries for the specified meter. Each object represents a recorded event or operation associated with the meter.
previousPagestringOptional
Cursor for the previous page of audit records, if available. Used for backward pagination.
nextPagestringOptional
Cursor for the next page of audit records, if available. Used for forward pagination.
errorobjectOptional
Container for error information returned by the API when the request fails.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error