AWS X-Ray
API Reference (API Version 2016-04-12)

GetTimeSeriesServiceStatistics

Get an aggregation of service statistics defined by a specific time range.

Request Syntax

POST /TimeSeriesServiceStatistics HTTP/1.1 Content-type: application/json { "EndTime": number, "EntitySelectorExpression": "string", "GroupARN": "string", "GroupName": "string", "NextToken": "string", "Period": number, "StartTime": number }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EndTime

The end of the time frame for which to aggregate statistics.

Type: Timestamp

Required: Yes

EntitySelectorExpression

A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No

GroupARN

The ARN of the group for which to pull statistics from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 400.

Required: No

GroupName

The case-sensitive name of the group for which to pull statistics from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

NextToken

Pagination token. Not used.

Type: String

Required: No

Period

Aggregation period in seconds.

Type: Integer

Required: No

StartTime

The start of the time frame for which to aggregate statistics.

Type: Timestamp

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ContainsOldGroupVersions": boolean, "NextToken": "string", "TimeSeriesServiceStatistics": [ { "EdgeSummaryStatistics": { "ErrorStatistics": { "OtherCount": number, "ThrottleCount": number, "TotalCount": number }, "FaultStatistics": { "OtherCount": number, "TotalCount": number }, "OkCount": number, "TotalCount": number, "TotalResponseTime": number }, "ResponseTimeHistogram": [ { "Count": number, "Value": number } ], "ServiceSummaryStatistics": { "ErrorStatistics": { "OtherCount": number, "ThrottleCount": number, "TotalCount": number }, "FaultStatistics": { "OtherCount": number, "TotalCount": number }, "OkCount": number, "TotalCount": number, "TotalResponseTime": number }, "Timestamp": 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.

ContainsOldGroupVersions

A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation may show statistics from an older version of the group's filter expression.

Type: Boolean

NextToken

Pagination token. Not used.

Type: String

TimeSeriesServiceStatistics

The collection of statistics.

Type: Array of TimeSeriesServiceStatistics objects

Errors

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

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: