In this article
Definitions
Timeseries
| Name | Description | Schema |
|---|---|---|
| timeseriesId | ID of the timeseries | string |
| timeseriesType | The timeseries type | string |
| dag | Metrics associated with the timeseries | <Metric> array |
| status | Specifies whether the timeseries is ‘active’ or ‘inactive’ | string |
| customData | Application specific data can be stored here | Dictionary<string,object> |
| systemData | Contains metadata about the object | SystemData |
Metric
| Name | Description | Schema |
|---|---|---|
| metric | Name of the metric | string |
| processingType | The type of processing to perform | string |
| frequency | Frequency of which batch metrics should be calculated | string (ISO 8601 Duration) |
| dataType | Data type of the output values (string, int, json etc.) | string |
Sample
| Name | Description | Schema |
|---|---|---|
| timeseriesId | Timeseries the TSElement belogs to | string |
| metric | Metric of the sample | string |
| timestamp | Timestamp of the sample | string(date-time) |
| val | Value of the sample | object |
| unixTimestamp | Unix timestamp of the sample | integer(int64) |
| customData | Application specific data can be stored here | Dictionary<string,object> |
| ingestUnixTimestamp | Unix timestamp the sample was saved to the database | integer(int64) |
| systemData | Contains metadata about the object | SystemData |
SystemData
| Name | Description | Schema |
|---|---|---|
| clientId | Client of the original post | string |
| requestorId | Requestor of the original post | string |
| transactionId | Transaction Id of the original post | string |
| correlationId | Correlation Id of the original post | string |
BulkRegisterTimeseries
| Name | Description | Schema |
|---|---|---|
| templateTimeseriesId | Id of the timeseries to use as a template | string |
| timeseriesIdsToRegister | List of timeseries Ids to create | array |