Query - Execute

  • Başvuru
Service:
Time Series Insights
API Version:
2020-07-31

Sonuç sayfalarında Zaman Serisi Sorgusu yürütür - Olay Alma, Seri Alma veya Toplama Serisi.

POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31
With optional parameters: 
POST https://{environmentFqdn}/timeseries/query?api-version=2020-07-31&storeType={storeType}

URI Parametreleri

Name İçinde Gerekli Tür Description
environmentFqdn
 path True

string

Ortam başına FQDN, örneğin 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Bu etki alanı adını Ortamları Al API'sinin, Azure portal veya Azure Resource Manager yanıtından alabilirsiniz.
api-version
 query True

string

İstemci isteğiyle kullanılacak API'nin sürümü. Şu anda desteklenen sürüm :"2020-07-31".
storeType
 query

string

Sıcak deponun etkinleştirildiği ortamlar için sorgu 'WarmStore' veya 'ColdStore' üzerinde yürütülebilir. Sorgudaki bu parametre, sorgunun hangi depoda yürütülmesi gerektiğini tanımlar. Tanımlanmamışsa, sorgu soğuk depoda yürütülür.

İstek Başlığı

Name Gerekli Tür Description
x-ms-continuation

string

Sayfalandırmayı destekleyen çağrılarda sonuçların sonraki sayfasını almak için önceki sonuç sayfasından devam belirteci. İlk sayfa sonuçlarını almak için parametre değeri olarak null devamlılık belirteci belirtin. Tüm sonuçlar döndürüldüyse ve bir sonraki sonuç sayfası yoksa döndürülen devamlılık belirteci null olur.
x-ms-client-request-id

string

İsteğe bağlı istemci istek kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında işlemi izlemesine ve müşterinin belirli bir istekle ilgili desteğe başvurmasına olanak tanır.
x-ms-client-session-id

string

İsteğe bağlı istemci oturum kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında bir grup ilgili işlemi izlemesine ve müşterinin belirli bir istek grubuyla ilgili desteğe başvurmasına olanak tanır.

İstek Gövdesi

Name Tür Description
aggregateSeries

AggregateSeries

Toplama Serisi sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan toplanan zaman serisini hesaplamaya olanak tanır.
getEvents

GetEvents

Olay alma sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için ham olayların alınmasına izin verir.
getSeries

GetSeries

Seriler sorgusunu alma. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan hesaplanan değişken değerlerinin zaman serisinin alınmasına izin verir.

Yanıtlar

Name Tür Description
200 OK

QueryResultPage

Başarılı sorgu.

Headers

x-ms-request-id: string
Other Status Codes

TsiError

Beklenmeyen hata.

Headers

x-ms-request-id: string

Güvenlik

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 kullanıcı hesabınızın kimliğine bürünme

Örnekler

ColdStoreQueryAggregateSeriesPage1
ColdStoreQueryAggregateSeriesPage2
ColdStoreQueryGetEventsPage1
ColdStoreQueryGetEventsPage2
ColdStoreQueryGetEventsPage3
ColdStoreQueryGetEventsPage4
ColdStoreQueryGetSeriesPage1
ColdStoreQueryGetSeriesPage2
ColdStoreQueryGetSeriesPage3
QueryAggregateSeriesPage1
QueryAggregateSeriesPage2
QueryAggregateSeriesWithCategoricalInterpolatedVariable
QueryAggregateSeriesWithCategoricalVariable
QueryAggregateSeriesWithSampleInterpolation
QueryGetEventsPage1
QueryGetEventsPage2
QueryGetEventsPage3
QueryGetEventsPage4
QueryGetEventsWithTakePage1
QueryGetEventsWithTakePage2
QueryGetSeriesPage1
QueryGetSeriesPage2
QueryGetSeriesPage3
QueryGetSeriesWithTakePage1
QueryGetSeriesWithTakePage2
WarmStoreQueryAggregateSeriesPage
WarmStoreQueryGetEventsPage1
WarmStoreQueryGetEventsPage2
WarmStoreQueryGetEventsPage3
WarmStoreQueryGetEventsPage4
WarmStoreQueryGetSeriesPage1
WarmStoreQueryGetSeriesPage2
WarmStoreQueryGetSeriesPage3

ColdStoreQueryAggregateSeriesPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

ColdStoreQueryAggregateSeriesPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "Count",
      "type": "Long",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        null
      ]
    },
    {
      "name": "AverageTemperature",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        null
      ]
    },
    {
      "name": "MinTemperature",
      "type": "Double",
      "values": [
        65.125,
        77.625,
        65.125,
        72.625,
        65.125,
        67.625,
        82.625,
        65.125,
        77.625,
        65.125,
        null
      ]
    },
    {
      "name": "MaxTemperature",
      "type": "Double",
      "values": [
        77.375,
        92.375,
        99.875,
        87.375,
        99.875,
        82.375,
        97.375,
        99.875,
        92.375,
        99.875,
        null
      ]
    }
  ],
  "progress": 100
}

ColdStoreQueryGetEventsPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetEventsPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetEventsPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        67.575
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetEventsPage4

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [],
  "properties": [],
  "progress": 100
}

ColdStoreQueryGetSeriesPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetSeriesPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

ColdStoreQueryGetSeriesPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=coldstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:21Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        67.825
      ]
    }
  ],
  "progress": 100
}

QueryAggregateSeriesPage1

Sample Request

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

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryAggregateSeriesPage2

Sample Request

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

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "Count",
      "type": "Long",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        null
      ]
    },
    {
      "name": "AverageTemperature",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        null
      ]
    },
    {
      "name": "MinTemperature",
      "type": "Double",
      "values": [
        65.125,
        77.625,
        65.125,
        72.625,
        65.125,
        67.625,
        82.625,
        65.125,
        77.625,
        65.125,
        null
      ]
    },
    {
      "name": "MaxTemperature",
      "type": "Double",
      "values": [
        77.375,
        92.375,
        99.875,
        87.375,
        99.875,
        82.375,
        97.375,
        99.875,
        92.375,
        99.875,
        null
      ]
    }
  ],
  "progress": 100
}

QueryAggregateSeriesWithCategoricalInterpolatedVariable

Sample Request

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

{
  "aggregateSeries": {
    "searchSpan": {
      "from": "2019-10-10T23:41:04.021Z",
      "to": "2019-10-10T23:42:22.846Z"
    },
    "timeSeriesId": [
      "Sensor_58"
    ],
    "interval": "PT2S",
    "inlineVariables": {
      "Status_String": {
        "kind": "categorical",
        "value": {
          "tsx": "$event.[Status].String"
        },
        "interpolation": {
          "kind": "Step",
          "boundary": {
            "span": "PT5S"
          }
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              "Good",
              "Very Good",
              "Excellent"
            ]
          },
          {
            "label": "Bad",
            "values": [
              "Bad",
              "OK"
            ]
          },
          {
            "label": "Other",
            "values": [
              "Other"
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      },
      "Status_Long": {
        "kind": "categorical",
        "value": {
          "tsx": "tolong($event.[Status].Double)"
        },
        "interpolation": {
          "kind": "Step",
          "boundary": {
            "span": "PT5S"
          }
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              0,
              1,
              2
            ]
          },
          {
            "label": "Bad",
            "values": [
              3,
              4
            ]
          },
          {
            "label": "Other",
            "values": [
              5
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      }
    },
    "projectedVariables": [
      "Status_String",
      "Status_Long"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2019-10-10T23:41:04Z",
    "2019-10-10T23:41:06Z",
    "2019-10-10T23:41:08Z",
    "2019-10-10T23:41:10Z",
    "2019-10-10T23:41:12Z",
    "2019-10-10T23:41:14Z",
    "2019-10-10T23:41:16Z",
    "2019-10-10T23:41:18Z",
    "2019-10-10T23:41:20Z",
    "2019-10-10T23:41:22Z"
  ],
  "properties": [
    {
      "values": [
        0.203,
        0.141,
        0.268,
        0.398,
        0.402,
        0.047,
        0.1245,
        0.75,
        0.206,
        0.2635
      ],
      "name": "Status_String[Good]",
      "type": "Double"
    },
    {
      "values": [
        0.266,
        0.1955,
        0.242,
        0.148,
        0.25,
        0.055,
        0.6295,
        0.109,
        0.41,
        0.2125
      ],
      "name": "Status_String[Bad]",
      "type": "Double"
    },
    {
      "values": [
        0.5205,
        0.6635,
        0.49,
        0.454,
        0.348,
        0.898,
        0.246,
        0.141,
        0.384,
        0.524
      ],
      "name": "Status_String[Other]",
      "type": "Double"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_String[Unknown]",
      "type": "Double"
    },
    {
      "values": [
        0.203,
        0.141,
        0.268,
        0.398,
        0.402,
        0.047,
        0.1245,
        0.75,
        0.206,
        0.2635
      ],
      "name": "Status_Long[Good]",
      "type": "Double"
    },
    {
      "values": [
        0.266,
        0.1955,
        0.242,
        0.148,
        0.25,
        0.055,
        0.6295,
        0.109,
        0.41,
        0.2125
      ],
      "name": "Status_Long[Bad]",
      "type": "Double"
    },
    {
      "values": [
        0.5205,
        0.6635,
        0.49,
        0.454,
        0.348,
        0.898,
        0.246,
        0.141,
        0.384,
        0.524
      ],
      "name": "Status_Long[Other]",
      "type": "Double"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_Long[Unknown]",
      "type": "Double"
    }
  ],
  "progress": 100
}

QueryAggregateSeriesWithCategoricalVariable

Sample Request

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

{
  "aggregateSeries": {
    "searchSpan": {
      "from": "2019-10-10T23:42:00.000Z",
      "to": "2019-10-10T23:42:20.000Z"
    },
    "timeSeriesId": [
      "Sensor_58"
    ],
    "interval": "PT2S",
    "inlineVariables": {
      "Status_String": {
        "kind": "categorical",
        "value": {
          "tsx": "$event.[Status].String"
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              "Good",
              "Very Good",
              "Excellent"
            ]
          },
          {
            "label": "Bad",
            "values": [
              "Bad",
              "OK"
            ]
          },
          {
            "label": "Other",
            "values": [
              "Other"
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      },
      "Status_Long": {
        "kind": "categorical",
        "value": {
          "tsx": "tolong($event.[Status].Double)"
        },
        "categories": [
          {
            "label": "Good",
            "values": [
              0,
              1,
              2
            ]
          },
          {
            "label": "Bad",
            "values": [
              3,
              4
            ]
          },
          {
            "label": "Other",
            "values": [
              5
            ]
          }
        ],
        "defaultCategory": {
          "label": "Unknown"
        }
      }
    },
    "projectedVariables": [
      "Status_String",
      "Status_Long"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2019-10-10T23:42:00Z",
    "2019-10-10T23:42:02Z",
    "2019-10-10T23:42:04Z",
    "2019-10-10T23:42:06Z",
    "2019-10-10T23:42:08Z",
    "2019-10-10T23:42:10Z",
    "2019-10-10T23:42:12Z",
    "2019-10-10T23:42:14Z",
    "2019-10-10T23:42:16Z",
    "2019-10-10T23:42:18Z"
  ],
  "properties": [
    {
      "values": [
        5,
        8,
        4,
        6,
        9,
        8,
        3,
        6,
        5,
        8
      ],
      "name": "Status_String[Good]",
      "type": "Long"
    },
    {
      "values": [
        4,
        3,
        3,
        5,
        5,
        3,
        9,
        7,
        7,
        7
      ],
      "name": "Status_String[Bad]",
      "type": "Long"
    },
    {
      "values": [
        11,
        9,
        13,
        9,
        6,
        9,
        8,
        7,
        8,
        5
      ],
      "name": "Status_String[Other]",
      "type": "Long"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_String[Unknown]",
      "type": "Long"
    },
    {
      "values": [
        5,
        8,
        4,
        6,
        9,
        8,
        3,
        6,
        5,
        8
      ],
      "name": "Status_Long[Good]",
      "type": "Long"
    },
    {
      "values": [
        4,
        3,
        3,
        5,
        5,
        3,
        9,
        7,
        7,
        7
      ],
      "name": "Status_Long[Bad]",
      "type": "Long"
    },
    {
      "values": [
        11,
        9,
        13,
        9,
        6,
        9,
        8,
        7,
        8,
        5
      ],
      "name": "Status_Long[Other]",
      "type": "Long"
    },
    {
      "values": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "name": "Status_Long[Unknown]",
      "type": "Long"
    }
  ],
  "progress": 100
}

QueryAggregateSeriesWithSampleInterpolation

Sample Request

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

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "LinearSampleInterpolation": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "interpolation": {
          "kind": "Linear",
          "boundary": {
            "span": "P1D"
          }
        },
        "aggregation": {
          "tsx": "left($value)"
        }
      },
      "StepSampleInterpolation": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "interpolation": {
          "kind": "Step",
          "boundary": {
            "span": "P1D"
          }
        },
        "aggregation": {
          "tsx": "left($value)"
        }
      }
    },
    "projectedVariables": [
      "LinearSampleInterpolation",
      "StepSampleInterpolation"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "LinearSampleInterpolation",
      "type": "Double",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        62
      ]
    },
    {
      "name": "StepSampleInterpolation",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        84
      ]
    }
  ],
  "progress": 100
}

QueryGetEventsPage1

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetEventsPage2

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

QueryGetEventsPage3

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        67.575
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0="
}

QueryGetEventsPage4

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [],
  "properties": [],
  "progress": 100
}

QueryGetEventsWithTakePage1

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ],
    "take": 10
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetEventsWithTakePage2

Sample Request

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

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ],
    "take": 10
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 100
}

QueryGetSeriesPage1

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetSeriesPage2

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

QueryGetSeriesPage3

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:21Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        67.825
      ]
    }
  ],
  "progress": 100
}

QueryGetSeriesWithTakePage1

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ],
    "take": 10
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

QueryGetSeriesWithTakePage2

Sample Request

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

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ],
    "take": 10
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 100
}

WarmStoreQueryAggregateSeriesPage

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "aggregateSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "interval": "PT1M",
    "inlineVariables": {
      "Count": {
        "kind": "aggregate",
        "filter": null,
        "aggregation": {
          "tsx": "count()"
        }
      },
      "MinTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "min($value)"
        }
      },
      "MaxTemperature": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "max($value)"
        }
      }
    },
    "projectedVariables": [
      "Count",
      "MinTemperature",
      "MaxTemperature"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:00Z",
    "2016-08-01T00:01:00Z",
    "2016-08-01T00:02:00Z",
    "2016-08-01T00:03:00Z",
    "2016-08-01T00:04:00Z",
    "2016-08-01T00:05:00Z",
    "2016-08-01T00:06:00Z",
    "2016-08-01T00:07:00Z",
    "2016-08-01T00:08:00Z",
    "2016-08-01T00:09:00Z",
    "2016-08-01T00:10:00Z"
  ],
  "properties": [
    {
      "name": "Count",
      "type": "Long",
      "values": [
        50,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        60,
        null
      ]
    },
    {
      "name": "AverageTemperature",
      "type": "Double",
      "values": [
        71.25,
        85,
        82.5,
        80,
        89.16666666666667,
        75,
        90,
        75.83333333333333,
        85,
        82.5,
        null
      ]
    },
    {
      "name": "MinTemperature",
      "type": "Double",
      "values": [
        65.125,
        77.625,
        65.125,
        72.625,
        65.125,
        67.625,
        82.625,
        65.125,
        77.625,
        65.125,
        null
      ]
    },
    {
      "name": "MaxTemperature",
      "type": "Double",
      "values": [
        77.375,
        92.375,
        99.875,
        87.375,
        99.875,
        82.375,
        97.375,
        99.875,
        92.375,
        99.875,
        null
      ]
    }
  ],
  "progress": 100
}

WarmStoreQueryGetEventsPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetEventsPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium",
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetEventsPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "Building",
      "type": "String",
      "values": [
        "Millenium"
      ]
    },
    {
      "name": "Temperature",
      "type": "Double",
      "values": [
        67.575
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetEventsPage4

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getEvents": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": {
      "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')"
    },
    "projectedProperties": [
      {
        "name": "Building",
        "type": "String"
      },
      {
        "name": "Temperature",
        "type": "Double"
      }
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [],
  "properties": [],
  "progress": 100
}

WarmStoreQueryGetSeriesPage1

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetSeriesPage2

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:10Z",
    "2016-08-01T00:00:11Z",
    "2016-08-01T00:00:12Z",
    "2016-08-01T00:00:13Z",
    "2016-08-01T00:00:14Z",
    "2016-08-01T00:00:15Z",
    "2016-08-01T00:00:16Z",
    "2016-08-01T00:00:17Z",
    "2016-08-01T00:00:18Z",
    "2016-08-01T00:00:19Z",
    "2016-08-01T00:00:20Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        65.125,
        65.375,
        65.625,
        65.875,
        66.125,
        66.375,
        66.625,
        66.875,
        67.125,
        67.375,
        67.625
      ]
    }
  ],
  "progress": 50,
  "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0="
}

WarmStoreQueryGetSeriesPage3

Sample Request

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/query?api-version=2020-07-31&storeType=warmstore

{
  "getSeries": {
    "timeSeriesId": [
      "006dfc2d-0324-4937-998c-d16f3b4f1952",
      "T1"
    ],
    "searchSpan": {
      "from": "2016-08-01T00:00:00Z",
      "to": "2016-08-01T00:16:50Z"
    },
    "filter": null,
    "inlineVariables": {
      "temperatures": {
        "kind": "numeric",
        "value": {
          "tsx": "$event.Temperature"
        },
        "filter": null,
        "aggregation": {
          "tsx": "avg($value)"
        }
      }
    },
    "projectedVariables": [
      "temperatures"
    ]
  }
}

Sample Response

Status code:
200 
{
  "timestamps": [
    "2016-08-01T00:00:21Z"
  ],
  "properties": [
    {
      "name": "temperatures",
      "type": "Double",
      "values": [
        67.825
      ]
    }
  ],
  "progress": 100
}

Tanımlar

Name Description
AggregateSeries

Toplama Serisi sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan toplanan zaman serisini hesaplamaya olanak tanır.
AggregateVariable

Toplama değişkeni toplama hesaplamalarını temsil eder. Toplama Değişkenleri ilişkilendirmeyi desteklemez.
Boundary

İlişkilendirme için kullanılacak arama aralığının sol ve sağındaki zaman aralığı. Bu, giriş arama aralığının başlangıcına veya sonuna yakın veri noktalarının eksik olduğu senaryolarda yararlıdır. Boş olabilir.
CategoricalVariable

Kategorik değişken, sınırlı tanımlı değer kümesinin oluşum sayısına veya süresine göre analiz edilmesi gereken sinyali temsil eder.
DateTimeRange

Zaman aralığı. Null veya negatif olamaz.
EventProperty

Depolanan veya hesaplanan bir olayın özelliği. Özellikler hem ada hem de türe göre tanımlanır. Farklı olaylar aynı ada ancak farklı türe sahip özelliklere sahip olabilir.
GetEvents

Olay alma sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için ham olayların alınmasına izin verir.
GetSeries

Seriler sorgusunu alma. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan hesaplanan değişken değerlerinin zaman serisinin alınmasına izin verir.
Interpolation

Ham veri noktalarında gerçekleştirilecek ilişkilendirme işlemi. Şu anda yalnızca ilişkilendirilmiş zaman serisi örneklemesine izin verilir. İzin verilen toplama işlevi - örneğin: left($value). İlişkilendirmenin uygulanması gerekmemesi durumunda null olabilir.
InterpolationKind

İlişkilendirme tekniğinin türü: "Doğrusal" veya "Adım".
NumericVariable

Sayısal değişken, ilişkilendirme kullanılarak yeniden oluşturulabilen tek bir sürekli sayısal sinyali temsil eder.
PropertyTypes

Özelliğin türü.
PropertyValues

Zaman damgalarına karşılık gelen tek bir özelliğin değerleri. Null değer içerebilir. Değer türü özelliğin türüyle eşleşir.
QueryRequest

Olaylar üzerinde bir zaman serisi sorgusu yürütme isteği. Tam olarak "getEvents", "getSeries" veya "aggregateSeries" kümelerinden biri ayarlanmalıdır.
QueryResultPage

Sorgu sonuçlarının tek bir sayfası. Sorgu henüz tamamlanmadıysa, bir sayfada devam belirteci ayarlanır. Bu durumda, bir sonraki sonuç sayfasını almak için devamlılık belirteci parametresiyle aynı isteği yeniden gönderin. Sorgu tamamlandıysa, devamlılık belirteci null olur. Henüz hiçbir sorgu sonucu hesaplanmadığında yalnızca devamlılık belirteci ayarlanmış boş bir sayfa almak da mümkündür. Disk belleği tamamlandıysa (devamlılık belirteci null ise), döndürülecek veri yoksa zaman damgaları ve özellikler boş olabilir.
TimeSeriesAggregateCategory

Kategorik değişkenlerde kullanılan kategori. Kategori, bu etikete atanan 'etiket' ve 'değerler' ile tanımlanır.
TimeSeriesDefaultCategory

Varsayılan kategoriyi temsil eder.
TsiError

API hatası hakkında bilgi.
TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.
TsiErrorDetails

Ek hata bilgileri.
Tsx

Tek bir dize olarak yazılmış zaman serisi ifadesi (TSX). Örnekler: "$event. Status.String='Good'", "avg($event. Sıcaklık)". Zaman serisi ifadeleri yazma belgelerine bakın.

AggregateSeries

Toplama Serisi sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan toplanan zaman serisini hesaplamaya olanak tanır.

Name Tür Description
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olaylar üzerinde üst düzey filtre. Bu filtre, her değişkende filtre ile and'ed şeklindedir. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
inlineVariables

object

Bu, kullanıcının isteğe bağlı olarak modelde önceden tanımlanmış olanlardan farklı satır içi değişkenleri tanımlamasına olanak tanır. Satır içi değişken adları modelle aynı ada sahip olduğunda, satır içi değişken tanımı önceliklidir. Boş olabilir.
interval

string

Aralık boyutu ISO-8601 süre biçiminde belirtilir. Tüm aralıklar aynı boyuttadır. Bir ay her zaman 30 güne dönüştürülür ve bir yıl her zaman 365 gündür. Örnekler: 1 dakika "PT1M", 1 milisaniye "PT0.001S" olur. Daha fazla bilgi için bkz. https://www.w3.org/TR/xmlschema-2/#duration.
projectedVariables

string[]

Bu, kullanıcının isteğe bağlı olarak yansıtılması gereken değişkenleri seçmesini sağlar. Null olduğunda veya ayarlanmadığında, satır içiVariables ve modeldeki tüm değişkenler döndürülür. Boş olabilir.
searchSpan

DateTimeRange

Sorgunun yürütüldiği zaman aralığı. Null olamaz.
timeSeriesId

TimeSeriesId[]

Tek bir zaman serisi örneğini (örneğin bir cihaz) benzersiz olarak tanımlayan tek bir Zaman Serisi Kimliği değeri. Ortam oluşturma zamanında Birden çok özellik Zaman Serisi Kimliği olarak belirtilirse tek bir Zaman Serisi Kimliğinin bileşik olabileceğini unutmayın. Değerlerin konumu ve türü, ortamda belirtilen ve Model Ayarı Api'si tarafından döndürülen Zaman Serisi Kimliği özellikleriyle eşleşmelidir. Null olamaz.

AggregateVariable

Toplama değişkeni toplama hesaplamalarını temsil eder. Toplama Değişkenleri ilişkilendirmeyi desteklemez.

Name Tür Description
aggregation

Tsx

Tür "toplama" olduğunda toplama zaman serisi ifadesi, "$event gibi olay özellikleri kullanılarak doğrudan gerçekleştirilmesi gereken toplamayı temsil etmek için kullanılır. Sıcaklık". Örneğin, sıcaklık değişiklik aralığını hesaplamak için toplama şu şekilde yazılabilir: "max($event. Sıcaklık)dk($event. Sıcaklık)".
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olayları filtreleyin. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
kind string:

aggregate

İzin verilen "tür" değerleri şunlardır: "sayısal" veya "toplama". "sayısal" yeniden yapılandırılmış sinyalin değerini ve bunları toplamak için ifadeyi belirtmenize olanak sağlarken, "toplama" türü değer belirtmeden olay özellikleri üzerinde doğrudan toplamanızı sağlar.

Boundary

İlişkilendirme için kullanılacak arama aralığının sol ve sağındaki zaman aralığı. Bu, giriş arama aralığının başlangıcına veya sonuna yakın veri noktalarının eksik olduğu senaryolarda yararlıdır. Boş olabilir.

Name Tür Description
span

string

CategoricalVariable

Kategorik değişken, sınırlı tanımlı değer kümesinin oluşum sayısına veya süresine göre analiz edilmesi gereken sinyali temsil eder.

Name Tür Description
categories

TimeSeriesAggregateCategory[]

Kategorik değişkenlerde kullanılan kategori. Kategori, bu etikete atanan 'etiket' ve 'değerler' ile tanımlanır.
defaultCategory

TimeSeriesDefaultCategory

Varsayılan kategoriyi temsil eder.
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olayları filtreleyin. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
interpolation

Interpolation

Kategorik değişken yalnızca 'step' ilişkilendirmesini destekler.
kind string:

categorical

İzin verilen "tür" değerleri şunlardır: "sayısal" veya "toplama". "sayısal" yeniden yapılandırılmış sinyalin değerini ve bunları toplamak için ifadeyi belirtmenize olanak sağlarken, "toplama" türü değer belirtmeden olay özellikleri üzerinde doğrudan toplamanızı sağlar.
value

Tsx

Değer zaman serisi ifadesi, kategorilere ayırılacak sinyalin değerini göstermek için kullanılır. Kategorik değişkenler için yalnızca 'String' veya 'Long' türünü değerlendirebilir.

DateTimeRange

Zaman aralığı. Null veya negatif olamaz.

Name Tür Description
from

string

Zaman aralığının başlangıç zaman damgası. Başlangıç zaman damgası, zaman serisi sorgu isteklerinde kullanıldığında dahil edilir. Bu zaman damgasına sahip olaylar dahil edilir.
to

string

Zaman aralığının bitiş zaman damgası. Zaman serisi sorgu isteklerinde kullanıldığında bitiş zaman damgası özeldir. Bu zaman damgasıyla eşleşen olaylar dışlanır. Bitiş zaman damgasının Get Availability tarafından döndürülenler dahil olduğunu unutmayın (tam olarak "bitiş" zaman damgasına sahip bir olay olduğu anlamına gelir).

EventProperty

Depolanan veya hesaplanan bir olayın özelliği. Özellikler hem ada hem de türe göre tanımlanır. Farklı olaylar aynı ada ancak farklı türe sahip özelliklere sahip olabilir.

Name Tür Description
name

string

Özelliğin adı.
type

PropertyTypes

Özelliğin türü.

GetEvents

Olay alma sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için ham olayların alınmasına izin verir.

Name Tür Description
filter

Tsx

Sorgudaki tüm değişkenlere uygulanacak olan sorgu için isteğe bağlı üst düzey filtre. Örnek: "$event. Status.String='Good'". Boş olabilir.
projectedProperties

EventProperty[]

Öngörülen özellikler, yansıtmak istediğiniz bir özellik dizisidir. Bu özellikler olaylarda görünmelidir; aksi takdirde, döndürülmedi.
searchSpan

DateTimeRange

Sorgunun yürütüldiği zaman aralığı. Null olamaz.
take

integer

Sayfa başına özellik değeri sayısı üst sınırı değil, tam yanıt kümesindeki özellik değeri sayısı üst sınırı. Ayarlanmadığında varsayılan olarak 10.000'e ayarlanır. Maksimum alma değeri 250.000 olabilir.
timeSeriesId

TimeSeriesId[]

Tek bir zaman serisi örneğini (örneğin bir cihaz) benzersiz olarak tanımlayan tek bir Zaman Serisi Kimliği değeri. Ortam oluşturma zamanında Birden çok özellik Zaman Serisi Kimliği olarak belirtilirse tek bir Zaman Serisi Kimliğinin bileşik olabileceğini unutmayın. Değerlerin konumu ve türü, ortamda belirtilen ve Model Ayarı Api'si tarafından döndürülen Zaman Serisi Kimliği özellikleriyle eşleşmelidir. Null olamaz.

GetSeries

Seriler sorgusunu alma. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan hesaplanan değişken değerlerinin zaman serisinin alınmasına izin verir.

Name Tür Description
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olaylar üzerinde üst düzey filtre. Bu filtre, her değişkende filtre ile and'ed şeklindedir. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
inlineVariables

object

İsteğe bağlı satır içi değişkenler, modeldeki zaman serisi türünde önceden tanımlanmış olan değişkenler dışındadır. Satır içi değişken adı modeldeki adla aynı olduğunda, satır içi değişken tanımı öncelikli olur. Boş olabilir.
projectedVariables

string[]

Sorgu sonucunda yansıtılması gereken seçili değişkenler. Null olduğunda veya ayarlanmadığında, modeldeki satır içiVariables ve zaman serisi türünden tüm değişkenler döndürülür. Boş olabilir.
searchSpan

DateTimeRange

Sorgunun yürütüldiği zaman aralığı. Null olamaz.
take

integer

Sayfa başına özellik değeri sayısı üst sınırı değil, tam yanıt kümesindeki özellik değeri sayısı üst sınırı. Ayarlanmadığında varsayılan olarak 10.000'e ayarlanır. Maksimum alma değeri 250.000 olabilir.
timeSeriesId

TimeSeriesId[]

Tek bir zaman serisi örneğini (örneğin bir cihaz) benzersiz olarak tanımlayan tek bir Zaman Serisi Kimliği değeri. Ortam oluşturma zamanında Birden çok özellik Zaman Serisi Kimliği olarak belirtilirse tek bir Zaman Serisi Kimliğinin bileşik olabileceğini unutmayın. Değerlerin konumu ve türü, ortamda belirtilen ve Model Ayarı Api'si tarafından döndürülen Zaman Serisi Kimliği özellikleriyle eşleşmelidir. Null olamaz.

Interpolation

Ham veri noktalarında gerçekleştirilecek ilişkilendirme işlemi. Şu anda yalnızca ilişkilendirilmiş zaman serisi örneklemesine izin verilir. İzin verilen toplama işlevi - örneğin: left($value). İlişkilendirmenin uygulanması gerekmemesi durumunda null olabilir.

Name Tür Description
boundary

Boundary

İlişkilendirme için kullanılacak arama aralığının sol ve sağındaki zaman aralığı. Bu, giriş arama aralığının başlangıcına veya sonuna yakın veri noktalarının eksik olduğu senaryolarda yararlıdır. Boş olabilir.
kind

InterpolationKind

İlişkilendirme tekniğinin türü: "Doğrusal" veya "Adım".

InterpolationKind

İlişkilendirme tekniğinin türü: "Doğrusal" veya "Adım".

Name Tür Description
Linear

string

Step

string

NumericVariable

Sayısal değişken, ilişkilendirme kullanılarak yeniden oluşturulabilen tek bir sürekli sayısal sinyali temsil eder.

Name Tür Description
aggregation

Tsx

Tür "sayısal" olduğunda toplama zaman serisi ifadesi, $value ifadesinde gerçekleştirilmesi gereken toplamayı temsil etmek için kullanılır. Bunun için $value belirtilmesi gerekir ve yalnızca toplama işlevlerinin içindeki $value kullanılabilir. Örneğin, $value minimumunu hesaplamak için toplama şu şekilde yazılır: "min($value)".
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olayları filtreleyin. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
interpolation

Interpolation

Ham veri noktalarında gerçekleştirilecek ilişkilendirme işlemi. Şu anda yalnızca ilişkilendirilmiş zaman serisi örneklemesine izin verilir. İzin verilen toplama işlevi - örneğin: left($value). İlişkilendirmenin uygulanması gerekmemesi durumunda null olabilir.
kind string:

numeric

İzin verilen "tür" değerleri şunlardır: "sayısal" veya "toplama". "sayısal" yeniden yapılandırılmış sinyalin değerini ve bunları toplamak için ifadeyi belirtmenize olanak sağlarken, "toplama" türü değer belirtmeden olay özellikleri üzerinde doğrudan toplamanızı sağlar.
value

Tsx

Değer zaman serisi ifadesi, toplanacak veya ilişkilendirilmiş sinyalin değerini temsil etmek için kullanılır. Örneğin, olaydaki sıcaklık değerleri şu şekilde gösterilir: "$event. Sıcaklık.Çift".

PropertyTypes

Özelliğin türü.

Name Tür Description
Bool

string

DateTime

string

Double

string

Long

string

String

string

TimeSpan

string

PropertyValues

Zaman damgalarına karşılık gelen tek bir özelliğin değerleri. Null değer içerebilir. Değer türü özelliğin türüyle eşleşir.

Name Tür Description
name

string

Özelliğin adı.
type

PropertyTypes

Özelliğin türü.
values

Values[]

Zaman damgalarına karşılık gelen tek bir özelliğin değerleri. Null değer içerebilir. Değer türü özelliğin türüyle eşleşir.

QueryRequest

Olaylar üzerinde bir zaman serisi sorgusu yürütme isteği. Tam olarak "getEvents", "getSeries" veya "aggregateSeries" kümelerinden biri ayarlanmalıdır.

Name Tür Description
aggregateSeries

AggregateSeries

Toplama Serisi sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan toplanan zaman serisini hesaplamaya olanak tanır.
getEvents

GetEvents

Olay alma sorgusu. Belirli bir Zaman Serisi Kimliği ve arama aralığı için ham olayların alınmasına izin verir.
getSeries

GetSeries

Seriler sorgusunu alma. Belirli bir Zaman Serisi Kimliği ve arama aralığı için olaylardan hesaplanan değişken değerlerinin zaman serisinin alınmasına izin verir.

QueryResultPage

Sorgu sonuçlarının tek bir sayfası. Sorgu henüz tamamlanmadıysa, bir sayfada devam belirteci ayarlanır. Bu durumda, bir sonraki sonuç sayfasını almak için devamlılık belirteci parametresiyle aynı isteği yeniden gönderin. Sorgu tamamlandıysa, devamlılık belirteci null olur. Henüz hiçbir sorgu sonucu hesaplanmadığında yalnızca devamlılık belirteci ayarlanmış boş bir sayfa almak da mümkündür. Disk belleği tamamlandıysa (devamlılık belirteci null ise), döndürülecek veri yoksa zaman damgaları ve özellikler boş olabilir.

Name Tür Description
continuationToken

string

Döndürülürse, geçerli sonuçların kısmi sonucu temsil ettiğini gösterir. Devamlılık belirteci, bir sonraki sonuç sayfasını almaya olanak tanır. Sorgu sonuçlarının sonraki sayfasını almak için aynı isteği "x-ms-continuation" HTTP üst bilgisinde devamlılık belirteci parametresiyle gönderin.
progress

number

Sorgunun yüzde olarak yaklaşık ilerlemesi. 0 ile 100 arasında olabilir. Yanıttaki devamlılık belirteci null olduğunda ilerlemenin 100 olması beklenir.
properties

PropertyValues[]

Zaman damgalarının her biri için zaman serisi özellikleri ve değerlerinin koleksiyonu. Sunucu bu istekteki sayfayı dolduramadıysa null veya devamlılık belirteci null olduğunda başka nesne yoksa boş olabilir.
timestamps

string[]

Zaman serisi değerlerinin zaman damgaları. Aralıklar üzerinde toplama kullanılırsa, zaman damgaları karşılık gelen aralıkların başlangıcını temsil eder. Olaylar alınırsa, zaman damgaları olayların zaman damgası $ts özelliği değerleridir. Sunucu bu istekteki sayfayı dolduramadıysa null veya devamlılık belirteci null olduğunda başka nesne yoksa boş olabilir.

TimeSeriesAggregateCategory

Kategorik değişkenlerde kullanılan kategori. Kategori, bu etikete atanan 'etiket' ve 'değerler' ile tanımlanır.

Name Tür Description
label

string

Çıkış değişkeni adlarını oluştururken kullanılacak kategorinin adı.
values

object[]

Bir kategorinin eşlendiğini değerlerin listesi. Benzersiz bir dize listesi veya uzun listesi olabilir.

TimeSeriesDefaultCategory

Varsayılan kategoriyi temsil eder.

Name Tür Description
label

string

'Kategoriler'de tanımlanan değerlerle eşleşmeyen değerlere atanacak varsayılan kategorinin adı.

TsiError

API hatası hakkında bilgi.

Name Tür Description
error

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details

TsiErrorDetails[]

Ek hata bilgileri içerir. Null olabilir.
innerError

TsiErrorBody

Nedeni daraltan daha belirli bir hata içerir. Null olabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.
target

string

Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı). Null olabilir.

TsiErrorDetails

Ek hata bilgileri.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.

Tsx

Tek bir dize olarak yazılmış zaman serisi ifadesi (TSX). Örnekler: "$event. Status.String='Good'", "avg($event. Sıcaklık)". Zaman serisi ifadeleri yazma belgelerine bakın.

Name Tür Description
tsx

string

Tek bir dize olarak yazılmış zaman serisi ifadesi (TSX). Örnekler: "$event. Status.String='Good'", "avg($event. Sıcaklık)". Zaman serisi ifadeleri yazma belgelerine bakın.