Amazon X-Ray · Schema

GetTimeSeriesServiceStatisticsRequest

GetTimeSeriesServiceStatisticsRequest schema from Amazon X-Ray API

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
StartTime object
EndTime object
GroupName object
GroupARN object
EntitySelectorExpression object
Period object
ForecastStatistics object
NextToken object
View JSON Schema on GitHub

JSON Schema

xray-get-time-series-service-statistics-request-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "StartTime",
    "EndTime"
  ],
  "title": "GetTimeSeriesServiceStatisticsRequest",
  "properties": {
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The start of the time frame for which to aggregate statistics."
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The end of the time frame for which to aggregate statistics."
        }
      ]
    },
    "GroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupName"
        },
        {
          "description": "The case-sensitive name of the group for which to pull statistics from."
        }
      ]
    },
    "GroupARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the group for which to pull statistics from."
        }
      ]
    },
    "EntitySelectorExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntitySelectorExpression"
        },
        {
          "description": "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. "
        }
      ]
    },
    "Period": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableInteger"
        },
        {
          "description": "Aggregation period in seconds."
        }
      ]
    },
    "ForecastStatistics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Pagination token."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-get-time-series-service-statistics-request-schema.json",
  "description": "GetTimeSeriesServiceStatisticsRequest schema from Amazon X-Ray API"
}