---
title: "GET /timeseries/describe/"
method: GET
path: "/timeseries/describe/"
---

# GET /timeseries/describe/

`GET /timeseries/describe/`

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

*   If the time series isn't associated with an asset property, specify the `alias` of the time series.
    
*   If the time series is associated with an asset property, specify one of the following:
    
    *   The `alias` of the time series.
        
    *   The `assetId` and `propertyId` that identifies the asset property.

## Query parameters

- `alias` string
- `assetId` string
- `propertyId` string

## Response `200`

Success

- DescribeTimeSeriesResponse
  - `assetId` string — The ID of the asset in which the asset property was created.
  - `propertyId` string — The ID of the asset property.
  - `alias` string — The alias that identifies the time series.
  - `timeSeriesId` string, required — The ID of the time series.
  - `dataType` 'STRING' | 'INTEGER' | 'DOUBLE' | 'BOOLEAN' | 'STRUCT', required — <p>The data type of the time series.</p> <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
  - `dataTypeSpec` string — <p>The data type of the structure for this time series. This parameter is required for time series that have the <code>STRUCT</code> data type.</p> <p>The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
  - `timeSeriesCreationDate` string, date-time, required — The date that the time series was created, in Unix epoch time.
  - `timeSeriesLastUpdateDate` string, date-time, required — The date that the time series was last updated, in Unix epoch time.
  - `timeSeriesArn` string, required — <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}</code> </p>

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceNotFoundException
- `482` — InternalFailureException
- `483` — ThrottlingException

---

[API](https://skmtc.net/aws/apis/iotsitewise.md) · [All operations](https://skmtc.net/aws/apis/iotsitewise/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotsitewise/versions/d13e5d3e0a6f/schema)