Audit Trail

Retrieve the list of export jobs for a meter

Retrieves the list of previously initiated export jobs for a specific meter in Zuora Mediation. You can filter the results by export type, session IDs, or request ID by using the exportType, sessionIds, and requestId query parameters. Use the requestId returned when you create an export job to retrieve a specific job. If requestId is omitted, the API returns the list of export jobs. Use the status and fileList fields to determine whether a job is complete and which files to download. Then use the "Retrieve the presigned URL for an export job" operation with each fileKey in fileList to obtain the download URLs.

get/meters/{meterId}/auditTrail/export

Path parameters

meterIdinteger required

ID of the meter.

Query parameters

exportType'SAMPLE' | 'ERROR'

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

sessionIdsstring[]

The session IDs of the meter run. For example, R-000001, R-000002.

requestIdstring

The unique identifier of an audit trail export job. Use the request ID returned when you create an export job to retrieve that specific job.

pageSizeinteger

Page size for pagination.

pageinteger

The page number.

Headers

Content-Typestring required

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

Accept-Encodingstring

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-Encodingstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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-Idstring

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

Response

OK

successboolean

Indicates whether the request was successful.

previousPagestring nullable

Cursor for the previous page of export jobs, if available. Used for backward pagination.

nextPagestring nullable

Cursor for the next page of export jobs, if available. Used for forward pagination.

Changes