API docs by Redocly

Dashboard API Documentation (1.0.0)

Download OpenAPI specification:Download

/api

Get System Stats

Responses

/api > /datasource

Get datasource types

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all available data sources

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/api/datasource

Request Body schema: application/x-www-form-urlencoded
name
string
datasource
string

Responses

/api > /dashboards

Get a list of all available resources (definitions)

Request Body schema: application/x-www-form-urlencoded
userid
string

The user id of the user.

Responses

Get all dashboards for user

Request Body schema: application/x-www-form-urlencoded
userid
string

The user id of the user.

Responses

Save a user dashboard

Request Body schema: application/x-www-form-urlencoded
userid
string

The user id of the user.

name
string

The guid of the dashboard.

dashboard
string

The dashboard JSON object.

Responses

Delete user dashboard

Responses

Get widget data - voss_device_cucm_phone Copy

Requests widget data for a specific resource.

{
"resource":"arbitrator_ciscocdr",
"resourceGuid":"",
"datasource":"LXT0",
"interval":4,
"timezone":"America/Chicago",
"timezoneOffset":360,"assetIds":[],
"fields": [
{
"guid":"WJDOSP0GRFWIVPTH1610050277189GLN49BS3XJW5XS",
"ruleName":"originalCalledPartyNumber",
"ruleType":0,
"headerName":"originalCalledPartyNumber",
"sort":1,
"operation":"Grouping Count",
"chartType":"line",
"cellFormat":0,
"mapping":null,
"isRatio":false
}
],
"filters":[],
"sorts":[],
"type":16,
"userGuid":"_lxt_created_",
"groupingLimit":10,
"settings":{
"overTime":false,
"dayPagination":true,
"treeTable":false,
"paging":false,
"description":null,"selectionType":0,"hideCount":false,"hideColumns":null,"defaultValue":"","timeFormat":"None","headerVertical":false,"sorting":0,"autoAdjustColumns":0,"paletteType":0,"palettes":[{"column":0,"palette":"_lxt_created_"}],"renderers":[{"guid":"WJDOSP0GRFWIVPTH1610050277189GLN49BS3XJW5XS","fieldName":"originalCalledPartyNumber","operation":"Grouping Count","fieldType":0,"valueType":1,"formatType":0,"chartType":0,"prefix":null,"suffix":null,"colGuid":null,"hideColumn":false,"numType":0,"bbType":0,"dateType":0,"allowEmpty":false,"allowTruthy":false,"floatPrecision":0,"progressMin":0,"progressMax":100,"align":0,"city":null,"region":null,"factor":1,"numberBase":"Base 10 (1000)"}]},"colorPalette":"_lxt_created_","previousJsonFile":"/var/reporter/reports/tmp/widget_2021_01_11_23_05_11_QRQD9TT36W.json","widgetGuid":"XNV6KFN5DORCVIGX16104062921750C2T6UPB85HC0T","widgetName":"sample api","csv_load_file":"/var/reporter/reports/tmp/UJV4EH70OC2KE0OL1610406355769T3VXFT8YUUW0A1.csv"}
Request Body schema: application/x-www-form-urlencoded
userid
string

The user id of the user.

lowerTs
integer

The starting timestamp in which to query the data. Expecting an epoch number.

upperTs
integer

The ending timestamp in which to query the data. Expecting an epoch number.

groupingLimit
integer

The data returned may produce too many different groups. Use this parameter to only return the top groups, ordered by count. ie. Top 10.

limit
integer

The data returned may produce too many results. Use this parameter to page through the data.

offset
integer

The data returned may produce too many results. Use this parameter in conjunction with the limit parameter to page through the data.

chartDto
string

ChartInputDto { resource (string): Resource name. This name must match one of the names returned from the "/dashboards/resources" api., userGuid (string): Guid of the user who created the resource., fields (array[FieldDto]): Array of Field Dtos. This list of fields determines the operations performed., filters (array[FieldFilterDto]): Array of Field Filter Dtos. This list of filters defines refines the search to a specific set of values. } FieldDto { ruleName (string): Rule name., operation (string): User selected operation., headerName (string): Custom header name to be displayed to the user. Used in the legend and table columns., sort (integer): Valid values are 0 = Ascending (default), or 1 = Descending., groupBy (boolean): True or False. Set this field to true to show all distinct values in the database. } FieldFilterDto { ruleName (string): Rule name., operation (string): User selected filter operation., filterValue (string): The filter value that was entered by the user. }

Responses

Response samples

Content type
application/json
{
  • "csv_filename": "/var/reporter/reports/tmp/widget__YSEAYVJE9B.csv",
  • "csv_load_file": "/var/reporter/reports/tmp/NG3L4NQPESC2QD8A1681271509169PI1HY1VE9CCA0P.csv",
  • "data": [
    ],
  • "filename": "",
  • "groupingTitle": "ChartDto",
  • "interval": 4,
  • "is3d": false,
  • "isLandscape": false,
  • "isOverTime": false,
  • "json_filename": "/var/reporter/reports/tmp/widget__YSEAYVJE9B.json",
  • "max_timestamp": 0,
  • "min_timestamp": 0,
  • "query_fields": {
    },
  • "query_max_timestamp": 0,
  • "query_min_timestamp": 0,
  • "query_results": {
    },
  • "settings": {
    },
  • "summary": {
    },
  • "title": "",
  • "totalCount": 65,
  • "type": 1
}

Save Schedule

header Parameters
Cookie
string
Example: PHPSESSID={{PHPSESSID}}
Request Body schema: application/x-www-form-urlencoded
userid
string
name
string
data
string

Responses

/api/v2

login

Authorizations:
noauthAuth
header Parameters
Content-Type
string
Example: application/x-www-form-urlencoded
Request Body schema: multipart/form-data
username
string
password
string

Responses

/api/v2 > dashboards

/api/v2 > dashboards > roles

Get Roles w/ Basic Auth

Authorizations:
noauthAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Request Body schema: application/x-www-form-urlencoded
userid
string

Responses

Save Role JSON (not supportted)

Authorizations:
noauthAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "guid": "BJ11CD7H1BB5K44Y1660318150121S1F92SJOXBVO1O",
  • "name": "Polycom",
  • "folderSync": false,
  • "dashboards": [
    ],
  • "dashboardGroups": [ ],
  • "users": [
    ],
  • "lastSavedEpoch": 1660686888,
  • "userGuid": "lxtrolesmodel",
  • "lastSavedDate": 8162022215448,
  • "syncOption": "Sync"
}

Delete Role

Authorizations:
noauthAuth
query Parameters
guid
string
userid
string
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

/api/v2 > users

GET All Users

header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

Add Normal User2

header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "userId": "testuser2",
  • "password": "password1",
  • "email": "[email protected]",
  • "firstName": "TFirst2",
  • "lastName": "TLast2",
  • "customerId": ""
}