GET

/metric-values#thingName&metricName&startTime&endTime

http://iot.{region}.amazonaws.com/metric-values#thingName&metricName&startTime&endTime

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

Access Token Required: API Key

Query Params

thingNamestringrequired

The name of the thing for which security profile metric values are returned.

metricNamestringrequired

The name of the security profile metric for which values are returned.

dimensionNamestring

The dimension name.

dimensionValueOperatorstring

The dimension value operator.

Allowed:

startTimestringrequired

The start of the time period for which metric values are returned.

endTimestringrequired

The end of the time period for which metric values are returned.

maxResultsinteger

The maximum number of results to return at one time.

nextTokenstring

The token for the next set of results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iot.{region}.amazonaws.com/metric-values#thingName&metricName&startTime&endTime' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}