List
Get events list.
https://api.nucle.cloud/v1/event/listRequest Header
| Name | Type | Required | Description |
|---|---|---|---|
| UserToken | string | True | The User Token, available from the Login methods. |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| presetId | string | True | The preset id. |
| args | object | True | The pagination arguments. |
Pagination Arguments Object
| Name | Type | Required | Description |
|---|---|---|---|
| skip | int | False | Skip a number of entries. |
| take | int | False | Take a number of entries. |
| orderType | enum | False |
Enum order type of the entries returned, HighToLow = 0 LowToHigh = 1 Newest = 2 Oldest = 3 |
Response
| Name | Type | Description |
|---|---|---|
| 200 OK | object | Events result. |
| 400 Bad Request | object | The outer wrapper for all responses with errors. |
Events result
| Name | Type | Description |
|---|---|---|
| totalCount | int | Total count of Events without paginations applied. |
| list | object | events list. |
Event Object
| Name | Type | Description |
|---|---|---|
| date | DateTime | The event date, |
| count | int | The event count in date. |
Error Object
| Name | Type | Description |
|---|---|---|
| code | int | Numerical HTTP code |
| status | string | Description of the HTTP code. |
| errorMessage | string | Description of the error |