GET api/nkis/{nki}/summary?begin={begin}&end={end}
Gives you a result summary of a given NKI during a given time period
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| nki |
NKI ID |
integer |
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
NKISummaryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| SentCount |
Number of NKI survey recipents |
integer |
None. |
| OpenCount |
Number of recipients that have opened/started the NKI survey |
integer |
None. |
| OpenPercent |
Percentage of recipients that have opened/started the NKI survey |
decimal number |
None. |
| UnopenCount |
Number of recipients that have not yet opened/started the NKI survey |
integer |
None. |
| UnopenPercent |
Percentage of recipients that have not yet opened/started the NKI survey |
decimal number |
None. |
| IncompleteCount |
Number of recipients that have opened/started the NKI survey but not yet completed it |
integer |
None. |
| IncompletePercent |
Percentage of recipients that have opened/started the NKI survey but not yet completed it |
decimal number |
None. |
| CompleteCount |
Number of recipients that have completed the NKI survey |
integer |
None. |
| CompletePercent |
Percentage of recipients that have completed the NKI survey |
decimal number |
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
{
"SentCount": 1,
"OpenCount": 2,
"OpenPercent": 200.0,
"UnopenCount": -1,
"UnopenPercent": -100.0,
"IncompleteCount": -1,
"IncompletePercent": -100.0,
"CompleteCount": 3,
"CompletePercent": 300.0,
"NKI": 1.0,
"PeriodStart": "2025-12-16T03:27:12.2494558+00:00",
"PeriodEnd": "2025-12-16T03:27:12.2494558+00:00",
"ID": 6,
"Created": "2025-12-16T03:27:12.2494558+00:00",
"Modified": "2025-12-16T03:27:12.2494558+00:00",
"Name": "sample string 7"
}