GET

/properties/history

http://iotsitewise.{region}.amazonaws.com/properties/history

Gets the history of an asset property's values. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying historical values</a> in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: <ul> <li> The <code>assetId</code> and <code>propertyId</code> of an asset property. </li> <li> A <code>propertyAlias</code>, which is a data stream alias (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>. </li> </ul>

Access Token Required: API Key

Query Params

assetIdstring

The ID of the asset.

propertyIdstring

The ID of the asset property.

propertyAliasstring

The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the IoT SiteWise User Guide.

startDatestring

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

endDatestring

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

qualitiesarray

The quality by which to filter asset data.

timeOrderingstring

The chronological sorting order of the requested information. Default: <code>ASCENDING</code>

Allowed:

nextTokenstring

The token to be used for the next set of paginated results.

maxResultsinteger

The maximum number of results to return for each paginated request. Default: 100

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://iotsitewise.{region}.amazonaws.com/properties/history' \
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}

GET