> This page is for Developers. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://zuora.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server. # Retrieve summary data for a meter POST https://rest.test.zuora.com/meters/{meterId}/summary Content-Type: application/json 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. Reference: https://zuora.ferndocs.com/developers/api-reference/zuora-api/mediation/meters/retrieve-meter-summary-data ## Authentication - `Authorization` header (bearer token, required) — Use `Bearer {{token}}` in the `Authorization` header for authentication. ## Servers - `https://rest.test.zuora.com` (US Developer & Central Sandbox (incl. Test Drive), default) - `https://rest.sandbox.na.zuora.com` (US API Sandbox Cloud 1) - `https://rest.apisandbox.zuora.com` (US API Sandbox Cloud 2) - `https://rest.na.zuora.com` (US Production Cloud 1) - `https://rest.zuora.com` (US Production Cloud 2) - `https://rest.test.eu.zuora.com` (EU Developer & Central Sandbox) - `https://rest.sandbox.eu.zuora.com` (EU API Sandbox) - `https://rest.eu.zuora.com` (EU Production) - `https://rest.test.ap.zuora.com` (APAC Developer & Central Sandbox) - `https://rest.ap.zuora.com` (APAC Production) ## Request ### Path parameters - `meterId` (long, required) — The ID of the meter. ### Headers - `Accept-Encoding` (string, optional) — 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, optional) — 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, optional) — An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/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, optional) — 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, optional) — 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 (`'`). ### Body (application/json) This endpoint expects a CreateSpecificMeterSummaryRequest. - `runType` (string, optional) — Specifies the type of run. - `sessionIds` (list of string, optional) — A list of specific run IDs to export. - `operatorIds` (list of string, optional) — A list of operator IDs to filter by. - `groupBy` (list of string, optional) — Specifies the fields used to group the summary results. - `queryFromTime` (string, optional) — The minimum timestamp for the data to be exported. - `queryToTime` (string, optional) — The maximum timestamp for the data to be exported. ## Response ### 200 OK - `success` (boolean, optional) — Indicates whether the request was successful. - `data` (SummaryResponse, optional) — List of audit trail entries for the specified meter. Each object represents a recorded event or operation associated with the meter. - `previousPage` (string, optional) — Cursor or URL for the previous page of audit records, if available. Used for backward pagination. - `nextPage` (string, optional) — Cursor or URL for the next page of audit records, if available. Used for forward pagination. - `error` (Error, optional) — Container for error information returned by the API when the request fails. ## Errors ### 400 Bad Request Error Bad Request - Invalid or missing parameters. - `errors` (list of ProxyBadRequestResponseErrorsItems, optional) - `success` (boolean, optional) ### 401 Unauthorized Error Unauthorized - Authentication failed. - `success` (boolean, optional) — Whether the API request has succeeded or not. - `data` (MediationErrorResponseData, optional) — Detailed response information for successful requests (e.g., instance info, job details). - `error` (MediationErrorResponseError, optional) — Contains error details when the request fails. ### 500 Internal Server Error Internal Server Error - Unexpected error. - `reasons` (list of ErrorResponseReasonsItems, optional) ## Types ### SummaryResponse - `requestId` (string, optional) — Unique identifier for the API request. - `requestTime` (string, optional) — Timestamp indicating when the request was made. - `query` (SummaryFilters, optional) — Defines the filters or parameters applied to the summary query. - `output` (list of SummaryGroupByResult, optional) — Lists grouped summary results based on the specified fields. ### Error - `code` (string, optional) — Machine-readable error code identifying the failure type. - `message` (string, optional) — Human-readable description of the error that provides more context about what went wrong. - `detail` (ErrorDetail, optional) — Additional structured details about the error, such as validation issues or parameter-specific information. ### ProxyBadRequestResponseErrorsItems - `code` (string, optional) — Machine-readable error code identifying the failure type. - `message` (string, optional) — Human-readable description of the error that provides more context about what went wrong. ### MediationErrorResponseData Detailed response information for successful requests (e.g., instance info, job details). - `id` (string, optional) — The instance ID. - `sessionId` (string, optional) — The session ID of the meter instance. - `jobId` (string, optional) — The job ID of the meter instance. - `meterId` (integer, optional) — The ID of the meter. - `version` (string, optional) — The meter version. - `revision` (string, optional) — The meter revision. - `runType` (integer, optional) — The run type of the instance. - `runTypeDescription` (string, optional) — The description of the run type. - `startTime` (string, optional) — The start time of the instance. - `status` (integer, optional) — The job status of the instance. - `statusDescription` (string, optional) — The status description of the instance. - `canExportSummary` (boolean, optional) — Whether the instance can export summary information (internal usage). - `hasLineageEnabled` (boolean, optional) — Whether lineage is enabled for the meter (internal usage). ### MediationErrorResponseError Contains error details when the request fails. - `code` (string, optional) — The error reason code (e.g., "70002006" for authorization errors). - `message` (string, optional) — A human-readable description of the error. ### ErrorResponseReasonsItems - `code` (string, optional) — The error code of response. - `message` (string, optional) — The detail information of the error response ### SummaryFilters - `runType` (string, optional) — Specifies the type of run. - `sessionIds` (list of string, optional) — A list of specific run IDs to export. - `operatorIds` (list of string, optional) — A list of operator IDs to filter by. - `groupBy` (list of string, optional) — Specifies the fields used to group the summary results. - `queryFromTime` (string, optional) — The minimum timestamp for the data to be exported. - `queryToTime` (string, optional) — The maximum timestamp for the data to be exported. ### SummaryGroupByResult - `dimensions` (map from string to SummaryGroupByResultDimensions, optional) — Stores dimension details or attributes used in grouping or filtering. - `output` (long, optional) — Represents the total number of output records or items. - `totalErrorCount` (long, optional) — Indicates the total count of errors in the response. ### ErrorDetail Additional structured details about the error, such as validation issues or parameter-specific information. ### SummaryGroupByResultDimensions Stores extra or custom fields not defined in the main schema. ## Examples **Request** ```json { "runType": "NORMAL", "sessionIds": [ "R-00002247", "R-00002293" ], "operatorIds": [ "4610a876-61ee-4e5e-a634-152e7a635f75" ], "groupBy": [ "errorCode", "processorId", "sessionId" ], "queryFromTime": "2025-10-01T0000+0000", "queryToTime": "2025-11-17T23:59:59+0000" } ``` **Response** ```json { "success": true, "data": { "requestId": "91d46fea-67de-4abe-9cc3-6ef076bbb7ea", "requestTime": "2025-11-20T16:41:27.858661268Z", "query": { "runType": "NORMAL", "sessionIds": [], "operatorIds": [], "groupBy": [ "sessionId" ] }, "output": [ { "dimensions": { "sessionId": "R-00002283" }, "output": 10000000, "totalErrorCount": 0 }, { "dimensions": { "sessionId": "R-00002340" }, "output": 10000000, "totalErrorCount": 0 } ] } } ``` **SDK Code** ```python Meters_retrieveMeterSummaryData_example import requests url = "https://rest.test.zuora.com/meters/1/summary" payload = { "runType": "NORMAL", "sessionIds": ["R-00002247", "R-00002293"], "operatorIds": ["4610a876-61ee-4e5e-a634-152e7a635f75"], "groupBy": ["errorCode", "processorId", "sessionId"], "queryFromTime": "2025-10-01T0000+0000", "queryToTime": "2025-11-17T23:59:59+0000" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Meters_retrieveMeterSummaryData_example const url = 'https://rest.test.zuora.com/meters/1/summary'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"runType":"NORMAL","sessionIds":["R-00002247","R-00002293"],"operatorIds":["4610a876-61ee-4e5e-a634-152e7a635f75"],"groupBy":["errorCode","processorId","sessionId"],"queryFromTime":"2025-10-01T0000+0000","queryToTime":"2025-11-17T23:59:59+0000"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Meters_retrieveMeterSummaryData_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://rest.test.zuora.com/meters/1/summary" payload := strings.NewReader("{\n \"runType\": \"NORMAL\",\n \"sessionIds\": [\n \"R-00002247\",\n \"R-00002293\"\n ],\n \"operatorIds\": [\n \"4610a876-61ee-4e5e-a634-152e7a635f75\"\n ],\n \"groupBy\": [\n \"errorCode\",\n \"processorId\",\n \"sessionId\"\n ],\n \"queryFromTime\": \"2025-10-01T0000+0000\",\n \"queryToTime\": \"2025-11-17T23:59:59+0000\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Meters_retrieveMeterSummaryData_example require 'uri' require 'net/http' url = URI("https://rest.test.zuora.com/meters/1/summary") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"runType\": \"NORMAL\",\n \"sessionIds\": [\n \"R-00002247\",\n \"R-00002293\"\n ],\n \"operatorIds\": [\n \"4610a876-61ee-4e5e-a634-152e7a635f75\"\n ],\n \"groupBy\": [\n \"errorCode\",\n \"processorId\",\n \"sessionId\"\n ],\n \"queryFromTime\": \"2025-10-01T0000+0000\",\n \"queryToTime\": \"2025-11-17T23:59:59+0000\"\n}" response = http.request(request) puts response.read_body ``` ```java Meters_retrieveMeterSummaryData_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://rest.test.zuora.com/meters/1/summary") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"runType\": \"NORMAL\",\n \"sessionIds\": [\n \"R-00002247\",\n \"R-00002293\"\n ],\n \"operatorIds\": [\n \"4610a876-61ee-4e5e-a634-152e7a635f75\"\n ],\n \"groupBy\": [\n \"errorCode\",\n \"processorId\",\n \"sessionId\"\n ],\n \"queryFromTime\": \"2025-10-01T0000+0000\",\n \"queryToTime\": \"2025-11-17T23:59:59+0000\"\n}") .asString(); ``` ```php Meters_retrieveMeterSummaryData_example request('POST', 'https://rest.test.zuora.com/meters/1/summary', [ 'body' => '{ "runType": "NORMAL", "sessionIds": [ "R-00002247", "R-00002293" ], "operatorIds": [ "4610a876-61ee-4e5e-a634-152e7a635f75" ], "groupBy": [ "errorCode", "processorId", "sessionId" ], "queryFromTime": "2025-10-01T0000+0000", "queryToTime": "2025-11-17T23:59:59+0000" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Meters_retrieveMeterSummaryData_example using RestSharp; var client = new RestClient("https://rest.test.zuora.com/meters/1/summary"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"runType\": \"NORMAL\",\n \"sessionIds\": [\n \"R-00002247\",\n \"R-00002293\"\n ],\n \"operatorIds\": [\n \"4610a876-61ee-4e5e-a634-152e7a635f75\"\n ],\n \"groupBy\": [\n \"errorCode\",\n \"processorId\",\n \"sessionId\"\n ],\n \"queryFromTime\": \"2025-10-01T0000+0000\",\n \"queryToTime\": \"2025-11-17T23:59:59+0000\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Meters_retrieveMeterSummaryData_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "runType": "NORMAL", "sessionIds": ["R-00002247", "R-00002293"], "operatorIds": ["4610a876-61ee-4e5e-a634-152e7a635f75"], "groupBy": ["errorCode", "processorId", "sessionId"], "queryFromTime": "2025-10-01T0000+0000", "queryToTime": "2025-11-17T23:59:59+0000" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://rest.test.zuora.com/meters/1/summary")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```