__namedParameters: { storage: IStorageBulkCreateData }

• storage: IStorageBulkCreateData

  Storage create schema

Optional options: IKvHttpRequestOptions

__namedParameters: { storage: IStorageDeleteData }

• storage: IStorageDeleteData

  Body of the request

Optional options: IKvHttpRequestOptions

__namedParameters: { query: IStorageRangeAdvancedData }

• query: IStorageRangeAdvancedData

  Request Schema

Optional options: IKvHttpRequestOptions

__namedParameters: { body: IStorageRangeAdvancedData }

• body: IStorageRangeAdvancedData

  Advanced range schema

Optional options: IKvHttpRequestOptions

__namedParameters: { assetName: string; fields: string; name: string }

• assetName: string

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='blank'>Kelvin Assets</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

• fields: string

  List of wanted field keys that are recorded in the payload. Normally this will be value.</p> If there are other unique keys/value pairs in the payload, then you can create a list of all keys to retrieve the values. e.g. 'value, key2'. If the key does not exist in the stored payload, that key will return with a value `null`.

• name: string

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='blank'>Kelvin Metric</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

Optional options: IKvHttpRequestOptions

__namedParameters: { query: IStorageLastData }

• query: IStorageLastData

  Request for multiple Metric selectors

Optional options: IKvHttpRequestOptions

__namedParameters: { agg: "none" | "count" | "distinct" | "integral" | "mean" | "median" | "mode" | "spread" | "stddev" | "sum" | "max" | "min"; assetName: string; endTime: Date; fields: string[]; fill: string; name: string; order: string; startTime: Date; timeBucket: string; timeShift: string }

• agg: "none" | "count" | "distinct" | "integral" | "mean" | "median" | "mode" | "spread" | "stddev" | "sum" | "max" | "min"

  Perform mathematical calculations on a group of data.</p> For numerical data there are twelve mathematical options available; `none` , `count`,`distinct`, `integral`, `mean`, `median`, `mode`, `spread`, `stddev`, `sum`, `max`, `min`.</p> For text based data there are three types of mathematical options available; `count`, `distinct`, `mode`. The default is `none`.</p> When using this parameter, you must also use the parameters `time_bucket` which defines how to group the data and `fields` which defines which payload data to use.

• assetName: string

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='blank'>Kelvin Assets</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

• endTime: Date

  End time of the recorded time to collect the payload data from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target='_blank'>Kelvin Platform</a> in ISO 8601 UTC date/time format. Example; '2022-07-08T08:41:01.657916Z'.

• fields: string[]

  Array of strings which each string representing one key inside the payload. Normally there will be only one key labeled `value`.

• fill: string

  Fills any group of data, which is defined by the `time_bucket` parameter, with a calculated value when there is no data in the database.</p> There are five options available; `none`, `null`, `linear`, `previous`, fixed integer value.</p> `none` will ignore the group. `null`, `previous` and fixed integer value will be added as the value for the empty group. `linear` will perform a linear regression to calculated the groups' value.</p> The default is `none`.

• name: string

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='blank'>Kelvin Metric</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

• order: string

  Order of the results for the timestamp parameter.</p> There are two options available (capital letters is required); `ASC` for ascending and `DESC` for descending. The default is `ASC`.

• startTime: Date

  Start time of the recorded time to collect the payload data from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target='_blank'>Kelvin Platform</a> in ISO 8601 UTC date/time format. Example; '2022-07-08T08:41:01.657916Z'.

• timeBucket: string

  Group the data by time frame for the `agg` parameter calculations.</p> The time can be adjusted with these time units `ns`, `ms`, `s`, `m`, `h`. e.g. `8765h` equates to is 8,765 hours which is approximately one year.

• timeShift: string

  Shift the time buckets from the epoch. Every time bucket starts from epoch so, if you want to calculate the time bucket starting on a different date and time, you'll need to set this. Example: `5m`, `1h`, `1w`.

Optional options: IKvHttpRequestOptions

Default value __namedParameters: { assetName: string[]; endingBefore: string; name: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}

• assetName: string[]

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='blank'>Kelvin Assets</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

• endingBefore: string

  An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metric</a> pairs in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.

• name: string[]

  Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='blank'>Kelvin Metric</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

• pageSize: number

  Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metric</a> pair objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metric</a> pair objects.

• search: string[]

  Search and filter the return list. Both the Display Name and the Name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Assets</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metrics</a> will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset&#39; target='_blank'>Kelvin Asset</a> name or display name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.

• sortAsc: boolean

  Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).

• sortBy: string

  Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are two parameter options; `name` and `asset.name`.</p> The default is `asset.name`

• startingAfter: string

  An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target='_blank'>Kelvin Metric</a> pairs in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.

Optional options: IKvHttpRequestOptions

__namedParameters: { storage: IStorageUpdateData }

• storage: IStorageUpdateData

  Body of the request

Optional options: IKvHttpRequestOptions

__namedParameters: { file: Blob }

• file: Blob

  CSV File

Optional options: IKvHttpRequestOptions