API : TCE box Event log

Introduction

This request is used to return logged events that has occurred on the TCE box or on a CPR logger Windows application.

Logs are stored for a maximum of 31 days.

Request

URL	https://api.telecomx.dk/tce/TCE_ID/eventlog
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER or ADMIN
Param	TCE_ID	MAC address of TCE box.
Query	offset	`[optional]` Index of the first event to return, default 0.
	limit	`[optional]` The number of events to return, default 100, min 1, max 500.
	source	`[optional]` Name of the subsystem that generated the event.
	filter	`[optional]` Search text that must be part of the event message.
	fromDate	`[optional]` Date and time from when to return events, defaults to today at 00:00.
	toDate	`[optional]` Date and time until when to return events, defaults to now. Max span between from and to dates is 7 days.

Query examples

https://api.telecomx.dk/tce/123456789012/eventlog
https://api.telecomx.dk/tce/123456789012/eventlog?filter=disconnected&fromDate=2016-01-01T00:00:00Z&toDate=2016-01-02T12:00:00Z&offset=100&limit=100

Response

JSON object
offset	Index of the first event returned.
limit	Number of events to return. Note that the actual number of event returned may be lower.
total	Number of events that can be returned when offset and limit is not considered. This is to be used for paging through the data.
logs	Array of events, see definition below.

Log event object (JSON)
when	Date	Time and date of when the event occurred.
level	String	Event level: INFO, WARNING or ERROR.
source	String	Name of the subsystem that generated the log event.
event	String	Message describing the event that was logged.

Note that properties holding no value may be omitted from the object.

Example

{
  offset: 0,
  limit: 100,
  total: 79,
  logs:
  [
    {
      when: '2016-07-06T10:58:58.047Z',
      level: 'WARNING',
      source: 'Main',
      event: 'Telecom Call Enhancer - running on ip: 192.168.23.9 and mac B827ECDCF3A8',
    },
    {
      ...
    }
  ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	id	Not found
500	internal_error	<Unspecified>

WIKI

Table of Contents