# Run a specific version of a meter

Executes a specific version of a meter in Zuora Mediation. You can choose to run it with either a local file or event store source by providing optional configurations.

Note on long-running meters and timeouts: 
For large meters with many operators, this API call might take longer to return and, in some cases, can time out even though the meter run has been successfully triggered.
To safely handle this, provide a uniqueKey field in the request body.
If the operation times out, retry the same request with the same uniqueKey.
If the original run already exists, the API returns a 400 error indicating a duplicate uniqueKey instead of creating a new run.

Endpoint: POST /meters/run/{meterId}/{version}
Version: 2026-05-08
Security: bearerAuth

## Path parameters:

  - `meterId` (string, required)
    The ID of the meter to run. You can find this ID in the Zuora Mediation UI URL when viewing a meter.

  - `version` (string, required)
    The version of the meter to run. Currently, the only supported value is 0.0.1 for all meters. Always pass 0.0.1 in this path parameter.
    Enum: "0.0.1"

## Header parameters:

  - `Content-Type` (string, required)
    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)
    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 (').

## Request fields (application/json):

  - `sourceOptions` (array)
    Settings for meter to run with local file.

  - `sourceOptions.processorId` (string)
    Source operator ID. Optional if there's only one local file source in the meter.

  - `sourceOptions.localFileId` (string)
    Internal ID of uploaded file.

  - `eventStoreSourceOptions` (array)
    Settings for meter to run with event store.

  - `eventStoreSourceOptions.processorId` (string, required)
    Source operator ID.

  - `eventStoreSourceOptions.startDate` (string)
    Start date of event store to query from (e.g., 2025-01-01).

  - `eventStoreSourceOptions.endDate` (string)
    End date of event store to query to (e.g., 2025-02-01).

  - `runtimeSourceConfigs` (array)
    Runtime source configurations to override source settings at execution time. Applies to both NORMAL and DEBUG runs.

  - `runtimeSourceConfigs.processorId` (string)
    ID of the source processor in the meter definition to apply this configuration to. Required when the meter has multiple sources of the same type.

  - `runtimeSourceConfigs.sourceType` (string, required)
    Type of the source. Must match the actual source type in the meter definition.
    Enum: "LOCAL_FS", "S3", "SNOWFLAKE", "EVENT_STORE"

  - `runtimeSourceConfigs.localFs` (object)
    Configuration options for LOCAL_FS sources (previously uploaded files).

  - `runtimeSourceConfigs.localFs.fileId` (integer, required)
    The ID of the file uploaded through the "Upload a file" operation, to be used as the source.

  - `runtimeSourceConfigs.s3` (object)
    Configuration options for S3 sources (paths, connection).

  - `runtimeSourceConfigs.s3.connectionName` (string)
    Name of the S3 connection to use.

  - `runtimeSourceConfigs.s3.connectionVersion` (integer)
    Version of the S3 connection.

  - `runtimeSourceConfigs.s3.paths` (array, required)
    List of S3 paths to read from.

  - `runtimeSourceConfigs.s3.fileFormat` (string, required)
    Format of the input files.
    Enum: "CSV", "EXCEL", "PARQUET", "JSON", "XML", "AVRO"

  - `runtimeSourceConfigs.s3.incremental` (boolean)
    Enables incremental mode to continuously monitor for new files. When false, files are processed only once.

  - `runtimeSourceConfigs.s3.monitorInterval` (integer)
    Interval in milliseconds for checking for new files when incremental mode is enabled. This field is applicable only when incremental is set to true.

  - `runtimeSourceConfigs.s3.retentionTime` (integer)
    Retention time in milliseconds for processed files.

  - `runtimeSourceConfigs.s3.batchSize` (integer)
    Batch size for reading files.

  - `runtimeSourceConfigs.snowflake` (object)
    Configuration options for Snowflake sources.

  - `runtimeSourceConfigs.snowflake.database` (string)
    Snowflake database name.

  - `runtimeSourceConfigs.snowflake.schema` (string)
    Snowflake schema name.

  - `runtimeSourceConfigs.snowflake.table` (string)
    Snowflake table name.

  - `runtimeSourceConfigs.snowflake.query` (string)
    Custom SQL query to execute (SELECT only).

  - `runtimeSourceConfigs.snowflake.warehouse` (string)
    Snowflake warehouse to use.

  - `runtimeSourceConfigs.snowflake.role` (string)
    Snowflake role to use.

  - `runtimeSourceConfigs.snowflake.unloadFileFormat` (string)
    File format for UNLOAD operation.
    Enum: "CSV", "EXCEL", "PARQUET", "JSON", "XML", "AVRO"

  - `runtimeSourceConfigs.snowflake.queryParameters` (object)
    Parameter values for parameterized queries (:paramName syntax).

  - `runtimeSourceConfigs.eventStore` (object)
    Configuration options for EventStore sources (date range).

  - `runtimeSourceConfigs.eventStore.storeId` (string, required)
    Event store ID to read from.

  - `runtimeSourceConfigs.eventStore.startDate` (string)
    Start date for partition pruning (YYYY-MM-DD).
    Example: "2025-01-01"

  - `runtimeSourceConfigs.eventStore.endDate` (string)
    End date for partition pruning (YYYY-MM-DD).
    Example: "2025-01-31"

  - `runtimeSourceConfigs.eventStore.query` (string)
    Ad-hoc SQL query for Event Store (SELECT only, mutually exclusive with date range).

  - `uniqueKey` (string)
    Optional idempotency key for this meter run. The uniqueKey is scoped to the meter (not tenant-wide).

When you trigger a meter run and the operation times out, you can safely retry the same request using the same uniqueKey.
If the original request already created a run, Zuora Mediation returns a 400 error indicating a duplicate uniqueKey and does not start a new run.
This behavior ensures idempotency and prevents duplicate meter executions.
    Example: "lms_meter2_2026-03-31T22:00:00Z"

## Response 200 fields (application/json):

  - `success` (boolean)
    Whether the API request has succeeded.

  - `data` (object)

  - `data.id` (string)
    Internal run history ID, unique within tenant.

  - `data.sessionId` (string)
    Corresponding session ID of this run.

  - `data.jobId` (string)
    Corresponding job ID of this run.

  - `data.meterId` (integer)
    Internal meter ID.

  - `data.version` (string)
    Version of the meter.

  - `data.revision` (integer)
    Revision number of this version run.

  - `data.runType` (integer)
    The run type:
- 1. NORMAL
- 2. DEBUG

  - `data.runTypeDescription` (string)
    Description of the run type.

  - `data.startTime` (string)
    Start time of this run.

  - `data.endTime` (string,null)
    End time of this run.

  - `data.status` (integer)
    The run status:
- 1. NEVER_RUN
- 2. TESTING
- 3. TESTING_FAILED
- 4. TESTING_PASSED
- 5. RUNNING
- 6. PAUSED
- 7. COMPLETED
- 8. FAILED
- 9. CANCELED
- 10. INITIALIZING
- 11. USAGE_PUSHING
- 12. PUSH_COMPLETED
- 13. CONSUME_COMPLETED

  - `data.statusDescription` (string)
    Description of the run status.

  - `data.canExportSummary` (boolean)
    Whether the summary is ready to export.

  - `data.hasLineageEnabled` (boolean)
    Whether lineage feature is enabled on this run.

  - `previousPage` (string)
    Cursor or URL for the previous page of audit records, if available. Used for backward pagination.

  - `nextPage` (string)
    Cursor or URL for the next page of audit records, if available. Used for forward pagination.

  - `error` (object)

  - `error.code` (string)
    Machine-readable error code identifying the failure type.

  - `error.message` (string)
    Human-readable description of the error that provides more context about what went wrong.

  - `error.detail` (object)
    Additional structured details about the error, such as validation issues or parameter-specific information.

## Response 400 fields (application/json):

  - `errors` (array)

  - `errors.code` (string)
    Machine-readable error code identifying the failure type.

  - `errors.message` (string)
    Human-readable description of the error that provides more context about what went wrong.

  - `success` (boolean)

## Response 401 fields (application/json):

  - `errors` (array)

  - `errors.code` (string)
    Machine-readable error code identifying the failure type.

  - `errors.message` (string)
    Human-readable description of the error that provides more context about what went wrong.

  - `success` (boolean)

## Response 500 fields (application/json):

  - `reasons` (array)
    Example: [{"code":"ObjectNotFound","message":"Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"}]

  - `reasons.code` (string)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response