Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchGetMetricData

Retrieves batches of metric data collected based on your sending activity.

You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).

Request Syntax


POST /v2/email/metrics/batch HTTP/1.1
Content-type: application/json

{
   "Queries": [ 
      { 
         "Dimensions": { 
            "string" : "string" 
         },
         "EndDate": number,
         "Id": "string",
         "Metric": "string",
         "Namespace": "string",
         "StartDate": number
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Queries

A list of queries for metrics to be retrieved.

Type: Array of BatchGetMetricDataQuery objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "Code": "string",
         "Id": "string",
         "Message": "string"
      }
   ],
   "Results": [ 
      { 
         "Id": "string",
         "Timestamps": [ number ],
         "Values": [ number ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

A list of MetricDataError encountered while processing your metric data batch request.

Type: Array of MetricDataError objects

Results

A list of successfully retrieved MetricDataResult.

Type: Array of MetricDataResult objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServiceErrorException

The request couldn't be processed because an error occurred with the Amazon SES API v2.

HTTP Status Code: 500

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429