Analytics Service

Retrieve a board

get
Authorizations
Path parameters
idstring · uuidRequired
Responses
200
Return a list of boards
application/json
get
GET /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
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
Path parameters
idstring · uuidRequiredExample: value should be 0 for a post
Body
Responses
200Success
post
POST /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
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
Path parameters
idstring · uuidRequired
Responses
200
The requested operation was performed.
application/json
delete
DELETE /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

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

Modify a board

put
Authorizations
Path parameters
idstring · uuidRequired
Body
Responses
200Success
put
PUT /api/v1/board/{id} HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
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
Path parameters
idstring · uuidRequired
Responses
200Success
get
GET /api/v1/board/{id}/devices HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

No content

retrieve board data for a given time period.

get
Authorizations
Path parameters
idstring · uuidRequired
Query parameters
fromDateintegerOptional
endDateintegerOptional
maxRecordsintegerOptionalDefault: 100
statsOnlybooleanOptionalDefault: false
pointsOnlybooleanOptionalDefault: false
pointsStatsOnlybooleanOptionalDefault: false
Responses
200Success
get
GET /api/v1/board/{id}/timepoints HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

No content

delete board data for a given time period.

delete
Authorizations
Path parameters
idstring · uuidRequired
Query parameters
fromDateintegerOptional
endDateintegerOptional
Responses
200
The requested operation was performed.
application/json
delete
DELETE /api/v1/board/{id}/timepoints HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

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

Get the country code for an IP address

get
Authorizations
Query parameters
ipliststringRequiredExample: 10.2.2.2,10.3.4.3
Responses
200
List of country codes.
application/json
get
GET /api/v1/iptocountry HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

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

Retrieve WiFi client history for debugging purpose

get
Authorizations
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
get
GET /api/v1/wifiClientHistory HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

No content

Retrieve WiFi client history for debugging purpose

get
Authorizations
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
get
GET /api/v1/wifiClientHistory/{client} HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

No content

Retrieve WiFi client history for debugging purpose

delete
Authorizations
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
DELETE /api/v1/wifiClientHistory/{client} HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Accept: */*

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

Retrieve different values from the running service.

get
Authorizations
Query parameters
commandstring · enumRequired

Get a value

Possible values:
Responses
200
Successful command execution
application/json
Responseone of
get
GET /api/v1/system HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
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
Body
one ofOptional
or
or
or
or
Responses
200
Successful command execution
application/json
Responseone of
or
or
post
POST /api/v1/system HTTP/1.1
Host: localhost:16009
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "command": "setloglevel",
  "subsystems": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}
{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}
PreviousProvisioning ServiceNextRadio Resource Management Service

Last updated