Dashboards Actions

https://api.losant.com/dashboards

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

Get

Returns the dashboards the current user has permission to see

Method And Url

GET https://api.losant.com/dashboards

Authentication

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

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, applicationId, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my * dashboard
applicationId	N	If not provided, return all dashboards. If provided but blank, only return dashboards that are not linked to applications. If provided and an id, only return dashboards linked to the given application id.		applicationId=575ec8687ae143cd83dc4a97
orgId	N	If not provided, return all dashboards. If provided but blank, only return dashboards belonging to the current user. If provided and an id, only return dashboards belonging to the given organization id.		orgId=575ece7e7ae143cd83dc4a9c

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.losant.com/dashboards

Successful Responses

Code	Type	Description
200	Dashboards	Collection of dashboards

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Post

Create a new dashboard

Method And Url

POST https://api.losant.com/dashboards

Authentication

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

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 Post schema. For example, the following would be a valid body for this request:

{
  "name": "My New Dashboard",
  "public": false
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My New Dashboard","public":false}' \
    https://api.losant.com/dashboards

Successful Responses

Code	Type	Description
201	Dashboard	Successfully created dashboard

Error Responses

Code	Type	Description
400	Error	Error if malformed request

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 keys
id:"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 Post

Schema for the body of a Dashboard creation request

Dashboard Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
orgId:{} 2 keys
▶
applicationId:{} 2 keys
▶
name:{} 3 keys
▶
blocks:{} 2 keys
▶
description:{} 2 keys
▶
refreshRate:{} 3 keys
▶
duration:{} 2 keys
▶
resolution:{} 2 keys
▶
defaultTheme:{} 2 keys
▶
reportConfigs:{} 3 keys
▶
public:{} 1 key
▶
password:{} 1 key
▶
contextConfiguration:{} 3 keys
additionalProperties:false
▶
required:[] 1 item

Dashboard Post Example

▶
root:{} 2 keys
name:"My New Dashboard"
public:false

Dashboards

Schema for a collection of Dashboards

Dashboards Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
orgId:{} 2 keys
▶
applicationId:{} 2 keys

Dashboards Example

▶
root:{} 7 keys
▶
items:[] 1 item
count:1
totalCount:5
perPage:1
page:0
sortField:"name"
sortDirection:"asc"

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 keys
type:"NotFound"
message:"Application was not found"