Analytics Service

Retrieve a board

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
Responses
200

Return a list of boards

application/json
get
/board/{id}

Create a board

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequiredExample: value should be 0 for a post
Body
Responses
200Success

No content

post
/board/{id}

No content

Remove a board

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
Responses
200

The requested operation was performed.

application/json
delete
/board/{id}

Modify a board

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
Body
Responses
200Success

No content

put
/board/{id}

No content

Get basic information about all the devices for a venue.

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
Responses
200Success

No content

get
/board/{id}/devices

No content

retrieve board data for a given time period.

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
Query parameters
fromDateintegerOptional
endDateintegerOptional
maxRecordsintegerOptionalDefault: 100
statsOnlybooleanOptionalDefault: false
pointsOnlybooleanOptionalDefault: false
pointsStatsOnlybooleanOptionalDefault: false
Responses
200Success

No content

get
/board/{id}/timepoints

No content

delete board data for a given time period.

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
Query parameters
fromDateintegerOptional
endDateintegerOptional
Responses
200

The requested operation was performed.

application/json
delete
/board/{id}/timepoints

Get the country code for an IP address

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
ipliststringRequiredExample: 10.2.2.2,10.3.4.3
Responses
200

List of country codes.

application/json
get
/iptocountry

Retrieve WiFi client history for debugging purpose

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fromDateintegerOptional
endDateintegerOptional
offsetintegerOptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegerOptional

Maximum number of entries to return (if absent, no limit is assumed)

macsOnlybooleanRequired

Maximum number of entries to return (if absent, no limit is assumed)

Default: false
macFilterstringOptional

Maximum number of entries to return (if absent, no limit is assumed)

Example: 112233445566, 11223344*, *5566
venuestring · uuidRequired

The venue to for the search.

Responses
200Success

No content

get
/wifiClientHistory

No content

Retrieve WiFi client history for debugging purpose

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
clientstringRequiredExample: 112233aabbcc
Query parameters
fromDateintegerOptional
endDateintegerOptional
offsetintegerOptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegerOptional

Maximum number of entries to return (if absent, no limit is assumed)

venuestring · uuidRequired

The venue to for the search.

orderBystringOptional

return extended information

Example: serialNumber:a,created:d
orderSpecbooleanOptional

return extended information

Default: false
Responses
200Success

No content

get
/wifiClientHistory/{client}

No content

Retrieve WiFi client history for debugging purpose

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
clientstringRequiredExample: 112233aabbcc
Query parameters
venuestring · uuidRequired

The venue to for the search.

fromDateintegerOptional
endDateintegerOptional
macFilterstringOptional

Maximum number of entries to return (if absent, no limit is assumed)

Example: 112233445566, 11223344*, *5566
Responses
200

The requested operation was performed.

application/json
delete
/wifiClientHistory/{client}

Retrieve different values from the running service.

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
commandstring · enumRequired

Get a value

Possible values:
Responses
200

Successful command execution

application/json
Responseone of
get
/system

Perform some system wide commands.

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
anyOptional
or
or
or
or
Responses
200

Successful command execution

application/json
Responseone of
or
or
post
/system

Last updated