# Retrieve summary data for a meter

Retrieves summary data for a specific meter in Zuora Mediation, providing a rolled-up view of a meter run or time window. The API supports grouping by Operator ID, Error Code, or Session ID, and allows optional filters such as Query From Time, Query To Time, Operator IDs, and Session IDs. The API returns aggregated output and error counts per group and includes validation with detailed error responses for invalid parameters or formats.

Endpoint: POST /meters/{meterId}/summary
Version: 2026-02-20
Security: bearerAuth

## Path parameters:

  - `meterId` (integer, required)
    The ID of the meter.

## 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):

  - `runType` (string)
    Specifies the type of run.
    Example: "NORMAL"

  - `sessionIds` (array)
    A list of specific run IDs to export.
    Example: ["R-00002247","R-00002293"]

  - `operatorIds` (array)
    A list of operator IDs to filter by.
    Example: ["4610a876-61ee-4e5e-a634-152e7a635f75"]

  - `groupBy` (array)
    Specifies the fields used to group the summary results.
    Example: ["errorCode","processorId","sessionId"]

  - `queryFromTime` (string)
    The minimum timestamp for the data to be exported.
    Example: "2025-10-01T0000+0000"

  - `queryToTime` (string)
    The maximum timestamp for the data to be exported.
    Example: "2025-11-17T23:59:59+0000"

## Response 200 fields (application/json):

  - `success` (boolean)
    Indicates whether the request was successful.

  - `data` (object)

  - `data.requestId` (string)
    Unique identifier for the API request.

  - `data.requestTime` (string)
    Timestamp indicating when the request was made.

  - `data.query` (object)

  - `data.query.runType` (string)
    Specifies the type of run.

  - `data.query.sessionIds` (array)
    A list of specific run IDs to export.

  - `data.query.operatorIds` (array)
    A list of operator IDs to filter by.

  - `data.query.groupBy` (array)
    Specifies the fields used to group the summary results.

  - `data.query.queryFromTime` (string)
    The minimum timestamp for the data to be exported.

  - `data.query.queryToTime` (string)
    The maximum timestamp for the data to be exported.

  - `data.output` (array)
    Lists grouped summary results based on the specified fields.

  - `data.output.dimensions` (object)
    Stores dimension details or attributes used in grouping or filtering.

  - `data.output.output` (integer)
    Represents the total number of output records or items.

  - `data.output.totalErrorCount` (integer)
    Indicates the total count of errors in the response.

  - `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):

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

  - `data` (object)
    Detailed response information for successful requests (e.g., instance info, job details).

  - `data.id` (string)
    The instance ID.

  - `data.sessionId` (string)
    The session ID of the meter instance.

  - `data.jobId` (string)
    The job ID of the meter instance.

  - `data.meterId` (integer)
    The ID of the meter.

  - `data.version` (string)
    The meter version.

  - `data.revision` (string)
    The meter revision.

  - `data.runType` (integer)
    The run type of the instance.

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

  - `data.startTime` (string)
    The start time of the instance.

  - `data.status` (integer)
    The job status of the instance.

  - `data.statusDescription` (string)
    The status description of the instance.

  - `data.canExportSummary` (boolean)
    Whether the instance can export summary information (internal usage).

  - `data.hasLineageEnabled` (boolean)
    Whether lineage is enabled for the meter (internal usage).

  - `error` (object)
    Contains error details when the request fails.

  - `error.code` (string)
    The error reason code (e.g., "70002006" for authorization errors).

  - `error.message` (string)
    A human-readable description of the error.

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