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 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 1000 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