Dashboard Actions

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

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

Delete

Deletes a dashboard

Method And Url

DELETE https://api.losant.com/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.Organization, all.User, dashboard.*, or dashboard.delete.

Request Path Components

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

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

Authentication

No authentication is required for this endpoint.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
password	N	Password for password-protected dashboards		password=myPassword

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -X GET \
    https://api.losant.com/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.losant.com/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.Organization, all.User, dashboard.*, or dashboard.patch.

Request Path Components

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

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.losant.com/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.losant.com/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.Organization, all.User, dashboard.*, or dashboard.sendReport.

Request Path Components

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

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

Validate Context

Validates a context object against the dashboard's context configuration

Method And Url

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

Authentication

No authentication is required for this endpoint.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
password	N	Password for password-protected dashboards		password=myPassword
duration	N	Duration of data to fetch in milliseconds		duration=3600000
resolution	N	Resolution in milliseconds		resolution=60000
end	N	End timestamp of the data, in ms since epoch		end=1465790400000

Request Body

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

{
  "myContextVariable": "myValue",
  "myOtherVariable": "575ecf887ae143cd83dc4aa2"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -X POST \
    -d '{"myContextVariable":"myValue","myOtherVariable":"575ecf887ae143cd83dc4aa2"}' \
    https://api.losant.com/dashboards/DASHBOARD_ID/validateContext

Successful Responses

Code	Type	Description
200	Validate Context Success	If context is valid

Error Responses

Code	Type	Description
400	Validate Context Error	Error if context is invalid
404	Error	Error if dashboard or application 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 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 Context Instance

Schema for a dashboard context instance

Dashboard Context Instance Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
patternProperties:{} 1 key
additionalProperties:false

Dashboard Context Instance Example

▶
root:{} 2 keys
myContextVariable:"myValue"
myOtherVariable:"575ecf887ae143cd83dc4aa2"

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 keys
name:"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 keys
type:"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 keys
jobQueued: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 key
success:true

Validate Context Error

Schema for the result of a validateContext call when invalid context is passed

Validate Context Error Schema

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

Validate Context Error Example

▶
root:{} 3 keys
type:"Validation"
message:"deviceId-noValidationNoFullDevice (589de9bca1975a00017b22ff) is not a valid deviceId"
▶
ctx:{} 5 keys

Validate Context Success

Schema for the result of a successful validateContext call

Validate Context Success Schema

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

Validate Context Success Example

▶
root:{} 3 keys
success:true
▶
dashboard:{} 5 keys
▶
ctx:{} 5 keys