Create a job to export audit trail data for a meter

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.

SecuritybearerAuth
Request
path Parameters
meterId
required
integer <int64>

The ID of the meter.

query Parameters
exportType
required
string

Type of the export.

runType
required
string

Specifies the type of run.

sessionIds
Array of strings

A list of specific run IDs to export.

runStatuses
Array of strings

Filters audit entries by their run status. If null, all statuses are included.

operatorIds
Array of strings

A list of operator IDs to filter by.

queryFromTime
required
string

The minimum timestamp for the data to be exported.

queryToTime
required
string

The maximum timestamp for the data to be exported.

format
string
Default: "csv"

The required format for the exported data.

header Parameters
Content-Type
required
string
Default: application/json

Specify the content type of the request body. Use application/json.

Accept-Encoding
string

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-Encoding
string

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-Ids
string

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-Ids
string

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-Id
string <= 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 (').

Responses
200

OK

400

Bad Request - Invalid or missing parameters.

401

Unauthorized - Authentication failed.

500

Internal Server Error - Unexpected error.

post/meters/{meterId}/auditTrail/export
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "data": {
    },
  • "previousPage": null,
  • "nextPage": null
}