Time Series Types - List

Service:: Time Series Insights

API Version:: 2020-07-31

Gets time series types in pages.

GET https://{environmentFqdn}/timeseries/types?api-version=2020-07-31

URI Parameters

Name	In	Required	Type	Description
environmentFqdn	path	True	string	Per environment FQDN, for example 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. You can obtain this domain name from the response of the Get Environments API, Azure portal, or Azure Resource Manager.
api-version	query	True	string	Version of the API to be used with the client request. Currently supported version is "2020-07-31".

Request Header

Name	Type	Description
x-ms-continuation	string	Continuation token from previous page of results to retrieve the next page of the results in calls that support pagination. To get the first page results, specify null continuation token as parameter value. Returned continuation token is null if all results have been returned, and there is no next page of results.
x-ms-client-request-id	string	Optional client request ID. Service records this value. Allows the service to trace operation across services, and allows the customer to contact support regarding a particular request.
x-ms-client-session-id	string	Optional client session ID. Service records this value. Allows the service to trace a group of related operations across services, and allows the customer to contact support regarding a particular group of requests.

Responses

Name	Type	Description
200 OK	GetTypesPage	Successful operation. Headers x-ms-request-id: string
Other Status Codes	TsiError	Unexpected error. Headers x-ms-request-id: string

Name

Type

Description

200 OK

GetTypesPage

Successful operation.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Unexpected error.

Headers

x-ms-request-id: string

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

TypesListPage1

TypesListPage2

TypesListPage3

TypesListPage1

Sample request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types?api-version=2020-07-31

Sample response

Status code:: 200

{
  "types": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

TypesListPage2

Sample request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types?api-version=2020-07-31

Sample response

Status code:: 200

{
  "types": [
    {
      "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "TurbineSensor",
      "description": "Wind turbine sensor",
      "variables": {
        "Value": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.value.Double"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

TypesListPage3

Sample request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types?api-version=2020-07-31

Sample response

Status code:: 200

{
  "types": []
}

Definitions

Name	Description
AggregateVariable	Aggregate variable represents any aggregation calculation. Aggregate Variables does not support interpolation.
Boundary	The time range to the left and right of the search span to be used for Interpolation. This is helpful in scenarios where the data points are missing close to the start or end of the input search span. Can be null.
CategoricalVariable	Categorical variable represents signal that needs to be analyzed based on the count or duration of occurrence of limited set of defined values.
GetTypesPage	Partial list of time series types returned in a single request.
Interpolation	The interpolation operation to be performed on the raw data points. Currently, only sampling of interpolated time series is allowed. Allowed aggregate function - eg: left($value). Can be null if no interpolation needs to be applied.
InterpolationKind	The type of interpolation technique : "Linear" or "Step".
NumericVariable	Numeric variable represents a single continuous numeric signal that can be reconstructed using interpolation.
TimeSeriesAggregateCategory	Category used in categorical variables. A category is defined by 'label' and the 'values' that are assigned this label.
TimeSeriesDefaultCategory	Represents the default category.
TimeSeriesType	Time series type defines variables or formulas for doing computation on events associated with time series instances. Each time series instance is associated with exactly one type. A type can have one or more variables. For example, a time series instance might be of type Temperature Sensor, which consists of the variables avg temperature, min temperature, and max temperature.
TsiError	Information about an API error.
TsiErrorBody	A particular API error with an error code and a message.
TsiErrorDetails	Additional error information.
Tsx	Time series expression (TSX) written as a single string. Examples: "$event.Status.String='Good'", "avg($event.Temperature)". Refer to the documentation on how to write time series expressions.

AggregateVariable

Object

Aggregate variable represents any aggregation calculation. Aggregate Variables does not support interpolation.

Name	Type	Description
aggregation	Tsx	Aggregation time series expression when kind is "aggregate" is used to represent the aggregation that needs to be performed directly using event properties like "$event.Temperature". For example, aggregation for calculating range of temperature changes can be written as: "max($event.Temperature)-min($event.Temperature)".
filter	Tsx	Filter over the events that restricts the number of events being considered for computation. Example: "$event.Status.String='Good'". Optional.
kind	string: aggregate	Allowed "kind" values are - "numeric" or "aggregate". While "numeric" allows you to specify value of the reconstructed signal and the expression to aggregate them, the "aggregate" kind lets you directly aggregate on the event properties without specifying value.

Boundary

Object

The time range to the left and right of the search span to be used for Interpolation. This is helpful in scenarios where the data points are missing close to the start or end of the input search span. Can be null.

Name	Type	Description
span	string (duration)

CategoricalVariable

Object

Categorical variable represents signal that needs to be analyzed based on the count or duration of occurrence of limited set of defined values.

Name	Type	Description
categories	TimeSeriesAggregateCategory[]	Category used in categorical variables. A category is defined by 'label' and the 'values' that are assigned this label.
defaultCategory	TimeSeriesDefaultCategory	Represents the default category.
filter	Tsx	Filter over the events that restricts the number of events being considered for computation. Example: "$event.Status.String='Good'". Optional.
interpolation	Interpolation	Categorical variable supports only 'step' interpolation.
kind	string: categorical	Allowed "kind" values are - "numeric" or "aggregate". While "numeric" allows you to specify value of the reconstructed signal and the expression to aggregate them, the "aggregate" kind lets you directly aggregate on the event properties without specifying value.
value	Tsx	Value time series expression is used to represent the value of the signal that is going to be categorized. It can evaluate to only 'String' or 'Long' type for categorical variables.

GetTypesPage

Object

Partial list of time series types returned in a single request.

Name	Type	Description
continuationToken	string	If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in "x-ms-continuation" HTTP header.
types	TimeSeriesType[]	Partial list of time series types returned in a single request. Can be empty if server was unable to fill the page with more types in this request, or there is no more types when continuation token is null.

Interpolation

Object

The interpolation operation to be performed on the raw data points. Currently, only sampling of interpolated time series is allowed. Allowed aggregate function - eg: left($value). Can be null if no interpolation needs to be applied.

Name	Type	Description
boundary	Boundary	The time range to the left and right of the search span to be used for Interpolation. This is helpful in scenarios where the data points are missing close to the start or end of the input search span. Can be null.
kind	InterpolationKind	The type of interpolation technique : "Linear" or "Step".

InterpolationKind

Enumeration

The type of interpolation technique : "Linear" or "Step".

Value	Description
Linear
Step

NumericVariable

Object

Numeric variable represents a single continuous numeric signal that can be reconstructed using interpolation.

Name	Type	Description
aggregation	Tsx	Aggregation time series expression when kind is "numeric" is used to represent the aggregation that needs to be performed on the $value expression. This requires $value to be specified and can only use $value inside the aggregate functions. For example, aggregation for calculating minimum of the $value is written as: "min($value)".
filter	Tsx	Filter over the events that restricts the number of events being considered for computation. Example: "$event.Status.String='Good'". Optional.
interpolation	Interpolation	The interpolation operation to be performed on the raw data points. Currently, only sampling of interpolated time series is allowed. Allowed aggregate function - eg: left($value). Can be null if no interpolation needs to be applied.
kind	string: numeric	Allowed "kind" values are - "numeric" or "aggregate". While "numeric" allows you to specify value of the reconstructed signal and the expression to aggregate them, the "aggregate" kind lets you directly aggregate on the event properties without specifying value.
value	Tsx	Value time series expression is used to represent the value of the signal that is going to be aggregated or interpolated. For example, temperature values from the event is represented like this: "$event.Temperature.Double".

TimeSeriesAggregateCategory

Object

Category used in categorical variables. A category is defined by 'label' and the 'values' that are assigned this label.

Name	Type	Description
label	string	The name of the category which will be used in constructing the output variable names.
values	object[]	The list of values that a category maps to. Can be either a unique list of string or list of long.

TimeSeriesDefaultCategory

Object

Represents the default category.

Name	Type	Description
label	string	The name of the default category which will be assigned to the values that does not match any of those that are defined in the 'categories'.

TimeSeriesType

Object

Time series type defines variables or formulas for doing computation on events associated with time series instances. Each time series instance is associated with exactly one type. A type can have one or more variables. For example, a time series instance might be of type Temperature Sensor, which consists of the variables avg temperature, min temperature, and max temperature.

Name	Type	Description
description	string	Description of the type. May be null.
id	string	Case-sensitive unique type identifier that is immutable. Can be null on create or update requests, and then server generates the ID. Not null on get and delete operations.
name	string	User-given unique name for the type. Mutable, not null.
variables	object	Different variables associated with the type. Not empty, not null.

TsiError

Object

Information about an API error.

Name	Type	Description
error	TsiErrorBody	A particular API error with an error code and a message.

TsiErrorBody

Object

A particular API error with an error code and a message.

Name	Type	Description
code	string	Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.
details	TsiErrorDetails[]	Contains additional error information. May be null.
innerError	TsiErrorBody	Contains more specific error that narrows down the cause. May be null.
message	string	Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.
target	string	Target of the particular error (for example, the name of the property in error). May be null.

TsiErrorDetails

Object

Additional error information.

Name	Type	Description
code	string	Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.
message	string	Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.

Tsx

Object

Time series expression (TSX) written as a single string. Examples: "$event.Status.String='Good'", "avg($event.Temperature)". Refer to the documentation on how to write time series expressions.

Name	Type	Description
tsx	string	Time series expression (TSX) written as a single string. Examples: "$event.Status.String='Good'", "avg($event.Temperature)". Refer to the documentation on how to write time series expressions.

Share via

Time Series Types - List

URI Parameters

Request Header

Responses

Security

azure_auth

Scopes

Examples

TypesListPage1

Sample request

Sample response

TypesListPage2

Sample request

Sample response

TypesListPage3

Sample request

Sample response

Definitions

AggregateVariable

Boundary

CategoricalVariable

GetTypesPage

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TsiError

TsiErrorBody

TsiErrorDetails

Tsx