Application Dashboard Actions

https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Below are the various requests that can be performed against the Application Dashboard resource, as well as the expected parameters and the potential responses.

Delete

Deletes a dashboard

Method And Url

DELETE https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, applicationDashboard.*, or applicationDashboard.delete.

Request Path Components

Path Component	Description	Example
DASHBOARD_ID	ID of the associated dashboard	575ece2b7ae143cd83dc4a9b
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Successful Responses

Code	Type	Description
200	Success	If dashboard was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if dashboard was not found

Get

Retrieves information on a dashboard

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationDashboard.*, or applicationDashboard.get.

Request Path Components

Path Component	Description	Example
DASHBOARD_ID	ID of the associated dashboard	575ece2b7ae143cd83dc4a9b
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Successful Responses

Code	Type	Description
200	Dashboard	Dashboard information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if dashboard was not found

Patch

Updates information about a dashboard

Method And Url

PATCH https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Authentication

Request Path Components

Path Component	Description	Example
DASHBOARD_ID	ID of the associated dashboard	575ece2b7ae143cd83dc4a9b
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Dashboard Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Dashboard",
  "description": "Description of my updated dashboard",
  "refreshRate": 300,
  "public": true
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Dashboard","description":"Description of my updated dashboard","refreshRate":300,"public":true}' \
    https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Successful Responses

Code	Type	Description
200	Dashboard	Update dashboard information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if dashboard was not found

Send Report

Sends a snapshot of a dashboard

Method And Url

POST https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Authentication

Request Path Components

Path Component	Description	Example
DASHBOARD_ID	ID of the associated dashboard	575ece2b7ae143cd83dc4a9b
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Dashboard Send Report schema. For example, the following would be a valid body for this request:

{
  "toEmail": [
    "email@example.com"
  ],
  "subject": "Dashboard Report",
  "message": "Lookit",
  "time": 1551887386704,
  "theme": "dark",
  "timezone": "America/New_York",
  "locale": "en-us"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"toEmail":["email@example.com"],"subject":"Dashboard Report","message":"Lookit","time":1551887386704,"theme":"dark","timezone":"America/New_York","locale":"en-us"}' \
    https://api.app.wnology.io/applications/APPLICATION_ID/dashboards/DASHBOARD_ID

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	If dashboard report was enqueued to be sent

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if dashboard was not found

Schemas

Dashboard

Schema for a single Dashboard

Dashboard Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 25 keys▶
id:{} 2 keys
▶
dashboardId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
organizationName:{} 3 keys
▶
organizationIconColor:{} 2 keys
▶
applicationId:{} 2 keys
▶
applicationName:{} 3 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
refreshRate:{} 3 keys
▶
duration:{} 2 keys
▶
resolution:{} 2 keys
▶
defaultTheme:{} 2 keys
▶
isPasswordProtected:{} 1 key
▶
public:{} 1 key
▶
reportConfigs:{} 3 keys
▶
blocks:{} 2 keys
▶
contextConfiguration:{} 3 keys

Dashboard Example

▶
(root){} 20 keysid:"575ece2b7ae143cd83dc4a9b"
dashboardId:"575ece2b7ae143cd83dc4a9b"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
organizationName:"Example Org"
organizationIconColor:"#284fff"
ownerType:"organization"
ownerId:"58238ff2fe7b4b01009a0554"
name:"My Dashboard"
description:"The best dashboard description"
refreshRate:60
public:false
isPasswordProtected:false
defaultTheme:"light"
blocks:[] 0 items
duration:600000
resolution:6000
_currentRole:"admin"
▶
reportConfigs:[] 1 item
▶
contextConfiguration:[] 5 items

Dashboard Patch

Schema for the body of a Dashboard modification request

Dashboard Patch Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys▶
name:{} 3 keys
▶
blocks:{} 2 keys
▶
reportConfigs:{} 3 keys
▶
description:{} 2 keys
▶
refreshRate:{} 3 keys
▶
duration:{} 2 keys
▶
resolution:{} 2 keys
▶
defaultTheme:{} 2 keys
▶
public:{} 1 key
▶
password:{} 1 key
▶
contextConfiguration:{} 3 keys
additionalProperties:false

Dashboard Patch Example

▶
(root){} 4 keysname:"My Updated Dashboard"
description:"Description of my updated dashboard"
refreshRate:300
public:true

Dashboard Send Report

Schema for the body of a Dashboard report request

Dashboard Send Report Schema

▶
(root){} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys▶
toEmail:{} 4 keys
▶
callbackUrl:{} 3 keys
▶
subject:{} 2 keys
▶
message:{} 2 keys
▶
theme:{} 2 keys
▶
time:{} 1 key
▶
timezone:{} 2 keys
▶
locale:{} 2 keys
▶
ctx:{} 5 keys
▶
branded:{} 1 key
▶
anyOf:[] 2 items
additionalProperties:false

Dashboard Send Report Example

▶
(root){} 7 keys▶
toEmail:[] 1 item
subject:"Dashboard Report"
message:"Lookit"
time:1551887386704
theme:"dark"
timezone:"America/New_York"
locale:"en-us"

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
(root){} 2 keystype:"NotFound"
message:"Application was not found"

Job Enqueued API Result

Schema for the result of a job being queued

Job Enqueued API Result Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
jobQueued:{} 2 keys
▶
jobId:{} 2 keys
▶
success:{} 2 keys

Job Enqueued API Result Example

▶
(root){} 3 keysjobQueued:true
jobId:"clnHvJbyVkOWAZwYAwLP4"
success:true

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key▶
success:{} 2 keys

Success Example

▶
(root){} 1 keysuccess:true

Was this page helpful?

Still looking for help? You can also search the WEGnology Forums or submit your question there.

Delete​

Method And Url​

Authentication​

Request Path Components​

Request Headers​

Curl Example​

Successful Responses​

Error Responses​

Get​

Method And Url​

Authentication​

Request Path Components​

Request Headers​

Curl Example​

Successful Responses​

Error Responses​

Patch​

Method And Url​

Authentication​

Request Path Components​

Request Headers​

Request Body​

Curl Example​

Successful Responses​

Error Responses​

Send Report​

Method And Url​

Authentication​

Request Path Components​

Request Headers​

Request Body​

Curl Example​

Successful Responses​

Error Responses​

Schemas​

Dashboard​

Dashboard Schema​

Dashboard Example​

Dashboard Patch​

Dashboard Patch Schema​

Dashboard Patch Example​

Dashboard Send Report​

Dashboard Send Report Schema​

Dashboard Send Report Example​

Error​

Error Schema​

Error Example​

Job Enqueued API Result​

Job Enqueued API Result Schema​

Job Enqueued API Result Example​

Success​

Success Schema​

Success Example​

Was this page helpful?

Delete

Method And Url

Authentication

Request Path Components

Request Headers

Curl Example

Successful Responses

Error Responses

Get

Method And Url

Authentication

Request Path Components

Request Headers

Curl Example

Successful Responses

Error Responses

Patch

Method And Url

Authentication

Request Path Components

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Send Report

Method And Url

Authentication

Request Path Components

Request Headers

Request Body

Curl Example

Successful Responses

Error Responses

Schemas

Dashboard

Dashboard Schema

Dashboard Example

Dashboard Patch

Dashboard Patch Schema

Dashboard Patch Example

Dashboard Send Report

Dashboard Send Report Schema

Dashboard Send Report Example

Error

Error Schema

Error Example

Job Enqueued API Result

Job Enqueued API Result Schema

Job Enqueued API Result Example

Success

Success Schema

Success Example