Analytics Service

Retrieve a board

get

Authorizations

bearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

200

Return a list of boards

application/json

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

get

/board/{id}

HTTPcURLJavaScriptPython

GET /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "venueList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "retention": 1,
      "interval": 1,
      "monitorSubVenues": true
    }
  ]
}

Create a board

post

Authorizations

bearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequiredExample: value should be 0 for a post

Body

application/json

Responses

200Success

No content

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

post

/board/{id}

HTTPcURLJavaScriptPython

POST /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "venueList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "retention": 1,
      "interval": 1,
      "monitorSubVenues": true
    }
  ]
}

No content

Remove a board

delete

Authorizations

bearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

200

The requested operation was performed.

application/json

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

delete

/board/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Modify a board

put

Authorizations

bearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Body

application/json

Responses

200Success

No content

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

put

/board/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "venueList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "retention": 1,
      "interval": 1,
      "monitorSubVenues": true
    }
  ]
}

No content

Get basic information about all the devices for a venue.

get

Authorizations

bearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

200Success

No content

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

get

/board/{id}/devices

HTTPcURLJavaScriptPython

GET /api/v1/board/{id}/devices HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

retrieve board data for a given time period.

get

Authorizations

bearerAuthApiKeyAuth

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

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

get

/board/{id}/timepoints

HTTPcURLJavaScriptPython

GET /api/v1/board/{id}/timepoints HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

delete board data for a given time period.

delete

Authorizations

bearerAuthApiKeyAuth

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

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

delete

/board/{id}/timepoints

HTTPcURLJavaScriptPython

DELETE /api/v1/board/{id}/timepoints HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get the country code for an IP address

get

Authorizations

bearerAuthApiKeyAuth

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

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

get

/iptocountry

HTTPcURLJavaScriptPython

GET /api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3 HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Retrieve WiFi client history for debugging purpose

get

Authorizations

bearerAuthApiKeyAuth

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

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

get

/wifiClientHistory

HTTPcURLJavaScriptPython

GET /api/v1/wifiClientHistory?macsOnly=false&venue=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve WiFi client history for debugging purpose

get

Authorizations

bearerAuthApiKeyAuth

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

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

get

/wifiClientHistory/{client}

HTTPcURLJavaScriptPython

GET /api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve WiFi client history for debugging purpose

delete

Authorizations

bearerAuthApiKeyAuth

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

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

delete

/wifiClientHistory/{client}

HTTPcURLJavaScriptPython

DELETE /api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Retrieve different values from the running service.

get

Authorizations

bearerAuthApiKeyAuth

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

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

get

/system

HTTPcURLJavaScriptPython

GET /api/v1/system?command=info HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": "text",
  "uptime": 1,
  "start": 1,
  "os": "text",
  "processors": 1,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 1
    }
  ]
}

Perform some system wide commands.

post

Authorizations

bearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

anyOptional

or

or

or

or

Responses

200

Successful command execution

application/json

Responseone of

or

or

400

The requested operation failed.

application/json

403

The requested does not have sufficient rights to perform the operation.

application/json

404

The specified resource was not found.

application/json

post

/system

HTTPcURLJavaScriptPython

POST /api/v1/system HTTP/1.1
Host: localhost:16009
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "command": "setloglevel",
  "subsystems": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}

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