Analytics Service

Retrieve a board

GEThttps://localhost:16009/api/v1/board/{id}

Path parameters

id*string (uuid)

Response

200400403404

Return a list of boards

Body

application/json

allOfObjectInfo (object)

venueListarray of VenueInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/board/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": []
  },
  "venueList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "monitorSubVenues": false
    }
  ]
}

Create a board

POSThttps://localhost:16009/api/v1/board/{id}

Path parameters

id*string (uuid)

Example: "value should be 0 for a post"

Body

application/json

allOfObjectInfo (object)

venueListarray of VenueInfo (object)

Response

200400403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/board/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400403404

{
  "ErrorDetails": "text"
}

Remove a board

DELETEhttps://localhost:16009/api/v1/board/{id}

Path parameters

id*string (uuid)

Response

200400403404

The requested operation was performed.

Body

application/json

Operationstring

Detailsstring

Codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/board/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "Operation": "text",
  "Details": "text"
}

Modify a board

PUThttps://localhost:16009/api/v1/board/{id}

Path parameters

id*string (uuid)

Body

application/json

allOfObjectInfo (object)

venueListarray of VenueInfo (object)

Response

200400403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/board/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400403404

{
  "ErrorDetails": "text"
}

Get basic information about all the devices for a venue.

GEThttps://localhost:16009/api/v1/board/{id}/devices

Path parameters

id*string (uuid)

Response

200400403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/board/{id}/devices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400403404

{
  "ErrorDetails": "text"
}

retrieve board data for a given time period.

GEThttps://localhost:16009/api/v1/board/{id}/timepoints

Path parameters

id*string (uuid)

Query parameters

Response

200400403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/board/{id}/timepoints', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400403404

{
  "ErrorDetails": "text"
}

delete board data for a given time period.

DELETEhttps://localhost:16009/api/v1/board/{id}/timepoints

Path parameters

id*string (uuid)

Query parameters

Response

200400403404

The requested operation was performed.

Body

application/json

Operationstring

Detailsstring

Codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/board/{id}/timepoints', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "Operation": "text",
  "Details": "text"
}

Get the country code for an IP address

GEThttps://localhost:16009/api/v1/iptocountry

Query parameters

Response

200400403404

List of country codes.

Body

application/json

enabledboolean

countryCodesarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "enabled": false,
  "countryCodes": [
    "text"
  ]
}

Retrieve WiFi client history for debugging purpose

GEThttps://localhost:16009/api/v1/wifiClientHistory

Query parameters

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/wifiClientHistory?macsOnly=false&venue=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

403404

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

Retrieve WiFi client history for debugging purpose

GEThttps://localhost:16009/api/v1/wifiClientHistory/{client}

Path parameters

client*string

Example: "112233aabbcc"

Query parameters

Response

200403404

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

403404

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

Retrieve WiFi client history for debugging purpose

DELETEhttps://localhost:16009/api/v1/wifiClientHistory/{client}

Path parameters

client*string

Example: "112233aabbcc"

Query parameters

Response

200403404

The requested operation was performed.

Body

application/json

Operationstring

Detailsstring

Codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "Operation": "text",
  "Details": "text"
}

Retrieve different values from the running service.

GEThttps://localhost:16009/api/v1/system

Query parameters

Response

200400403404

Successful command execution

Body

application/json

one of

SystemInfoResults (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/system?command=info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "version": "text",
  "os": "text",
  "hostname": "text",
  "certificates": [
    {
      "filename": "text"
    }
  ]
}

Perform some system wide commands.

POSThttps://localhost:16009/api/v1/system

Body

application/json

Command details

one of

SystemCommandSetLogLevel (object)SystemCommandReload (object)SystemCommandGetLogLevels (object)SystemCommandGetLogLevelNames (object)SystemCommandGetSubsystemNames (object)

Response

200400403404

Successful command execution

Body

application/json

one of

SystemGetLogLevelsResult (object)SystemCommandGetLogLevelNamesResult (object)SystemGetSubSystemNamesResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16009/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403404

{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}