GET api/nkis/{nki}/timeseries/{interval}?begin={begin}&end={end}

Gives you a time series for the results of a given NKI during a given time period

Request Information

URI Parameters

NameDescriptionTypeAdditional information
nki

NKI ID

integer

Required

interval

Interval size of each timeseries entry

IntervalSize

Required

begin

Start of requested period (UTC, inclusive)

date

Required

end

End of requested period (UTC, exclusive)

date

Required

Body Parameters

None.

Response Information

Resource Description

Summary of NKI

Collection of NKITimeSeriesEntryDTO
NameDescriptionTypeAdditional information
Interval

Size of time series entry interval

string

None.

NKI

NKI value

decimal number

None.

PeriodStart

Timestamp for the start of the requested period, inclusive

date

None.

PeriodEnd

Timestamp for the end of the requested period, exclusive

date

None.

ID

NKI ID

integer

None.

Created

Timestamp for NKI creation

date

None.

Modified

Timestamp for last modification of NKI

date

None.

Name

NKI name

string

Required

String length: inclusive between 0 and 150

Response Formats

application/json, text/json

Sample:
[
  {
    "Interval": "Daily",
    "NKI": 1.0,
    "PeriodStart": "2019-10-23T22:28:40.0710127+00:00",
    "PeriodEnd": "2019-10-23T22:28:40.0710127+00:00",
    "ID": 3,
    "Created": "2019-10-23T22:28:40.0710127+00:00",
    "Modified": "2019-10-23T22:28:40.0710127+00:00",
    "Name": "sample string 4"
  },
  {
    "Interval": "Daily",
    "NKI": 1.0,
    "PeriodStart": "2019-10-23T22:28:40.0710127+00:00",
    "PeriodEnd": "2019-10-23T22:28:40.0710127+00:00",
    "ID": 3,
    "Created": "2019-10-23T22:28:40.0710127+00:00",
    "Modified": "2019-10-23T22:28:40.0710127+00:00",
    "Name": "sample string 4"
  }
]