---
title: "Retrieve summary data for a meter"
method: POST
path: "/meters/{meterId}/summary"
tags: ["Meters"]
---

# Retrieve summary data for a meter

`POST /meters/{meterId}/summary`

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.

## Path parameters

- `meterId` integer, required

## Headers

- `Content-Type` string, required
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Request body

- CreateSpecificMeterSummaryRequest
  - `runType` string — Specifies the type of run.
  - `sessionIds` string[] — A list of specific run IDs to export.
  - `operatorIds` string[] — A list of operator IDs to filter by.
  - `groupBy` string[] — Specifies the fields used to group the summary results.
  - `queryFromTime` string — The minimum timestamp for the data to be exported.
  - `queryToTime` string — The maximum timestamp for the data to be exported.

## Response `200`

OK

- CreateSpecificMeterSummaryResponse
  - `success` boolean — Indicates whether the request was successful.
  - `data` SummaryResponse
    - `requestId` string — Unique identifier for the API request.
    - `requestTime` string — Timestamp indicating when the request was made.
    - `query` SummaryFilters
      - `runType` string — Specifies the type of run.
      - `sessionIds` string[], nullable — A list of specific run IDs to export.
      - `operatorIds` string[], nullable — A list of operator IDs to filter by.
      - `groupBy` string[] — Specifies the fields used to group the summary results.
      - `queryFromTime` string, nullable — The minimum timestamp for the data to be exported.
      - `queryToTime` string, nullable — The maximum timestamp for the data to be exported.
    - `output` SummaryGroupByResult[] — Lists grouped summary results based on the specified fields.
      - `dimensions` object — Stores dimension details or attributes used in grouping or filtering.
      - `output` integer — Represents the total number of output records or items.
      - `totalErrorCount` integer — Indicates the total count of errors in the response.
  - `previousPage` string, nullable — Cursor or URL for the previous page of audit records, if available. Used for backward pagination.
  - `nextPage` string, nullable — Cursor or URL for the next page of audit records, if available. Used for forward pagination.
  - `error` Error
    - `code` string — Machine-readable error code identifying the failure type.
    - `message` string — Human-readable description of the error that provides more context about what went wrong.
    - `detail` object — Additional structured details about the error, such as validation issues or parameter-specific information.

## Other responses

- `400` — Bad Request - Invalid or missing parameters.
- `401` — Unauthorized - Authentication failed.
- `500` — Internal Server Error - Unexpected error.

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)