Experience Views Actions

https://api.losant.com/applications/APPLICATION_ID/experience/views

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

Get

Returns the experience views for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/views

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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceViews.*, or experienceViews.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: id, creationDate, name, 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*view`
viewType	N	Filter views to those only of the given type. Accepted values are: page, layout, component		`viewType=page`
version	N	Return the experience views belonging to this version	develop	`version=develop`

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/applications/APPLICATION_ID/experience/views

Successful Responses

Code	Type	Description
200	Experience Views	Collection of experience views

Error Responses

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

Post

Create a new experience view for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/experience/views

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.cli, all.Organization, all.User, all.User.cli, experienceViews.*, or experienceViews.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the 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 Experience View Post schema. For example, the following would be a valid body for this request:

{
  "name": "My Page View",
  "viewType": "page",
  "body": "<p>{{data}}</p>",
  "layoutId": "59cc5cad8246c6caed4b16c2",
  "viewTags": {
    "customKey": "customValue"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My Page View","viewType":"page","body":"<p>{{data}}</p>","layoutId":"59cc5cad8246c6caed4b16c2","viewTags":{"customKey":"customValue"}}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/views

Successful Responses

Code	Type	Description
201	Experience View	Successfully created experience view

Error Responses

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

Schemas

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"

Experience View

Schema for a single Experience View

Experience View Schema

▶
root:{} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 17 keys▶
id:{} 2 keys
▶
experienceViewId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
viewType:{} 2 keys
▶
layoutId:{} 2 keys
▶
layoutName:{} 3 keys
▶
body:{} 2 keys
▶
viewTags:{} 3 keys
▶
headers:{} 3 keys

Experience View Example

▶
root:{} 10 keysid:"59cc5c628246c6caed4b16c1"
experienceViewId:"59cc5c628246c6caed4b16c1"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Page View"
viewType:"page"
body:"<p>{{data}}</p>"
layoutId:"59cc5cad8246c6caed4b16c2"
▶
viewTags:{} 1 key

Experience View Post

Schema for the body of an Experience View creation request

Experience View Post Schema

▶
root:{} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys▶
name:{} 3 keys
▶
description:{} 2 keys
▶
viewType:{} 2 keys
▶
layoutId:{} 2 keys
▶
body:{} 2 keys
▶
viewTags:{} 3 keys
▶
headers:{} 3 keys
additionalProperties:false
▶
required:[] 2 items

Experience View Post Example

▶
root:{} 5 keysname:"My Page View"
viewType:"page"
body:"<p>{{data}}</p>"
layoutId:"59cc5cad8246c6caed4b16c2"
▶
viewTags:{} 1 key