Get Logs v2.0
| API version | 2.0 |
|---|---|
| Last Update | 10/25/2014 |
| Authentication | YES |
| Response Format | JSON |
| HTTP Method | GET |
| Rate limited | YES |
| Requests per rate limit | 10/min |
To retrieve event logs on your account.
API URL
Request Parameters
| Key | Datatype | Parameter Type | Required | Description | Default |
|---|---|---|---|---|---|
| access_token | string | URL | Yes | access token which archived from OAuth authentication step | |
| limit | int | URL | Optional | Specific maximum number of event logs will be returned in the response. The value should be in [1,50]. If there are more event logs than what the limit asks for, error code will be 406. Event logs in response is ordered by date. | 1 |
| page | int | URL | Optional | Specific page number which event logs will be returned in. If the requested page exceeds the number of pages of event logs, error code will be 413. It means that the requested page number is too large, no devices will be returned in this case. | 1 |
| event_type | int | URL | Optional | Specific what kind of event logs you want to retrieve.
1: device events 2: administrator events | 1 |
Response HTTP Code
| HTTP Code | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized. Your access_token is invalid or expired |
| 406 | Too many records to return |
| 413 | Requested page number exceeds limit |
Response Parameters
| Key | DataType | Description |
|---|---|---|
| logs | array<object> | Lists of event logs |
| eventlog | array<string> | Array of events of the event log. The information will be formated as "<hh:mm> | [AM/PM] | <event category> | <device's hostname> | <event description>" |
| date | string | timestamp when the event log occurs |
Example
Example Request
Example Response
Was this page helpful?