Data Actions

https://api.losant.com/applications/APPLICATION_ID/data

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

Export

Creates a csv file from a query of devices and attributes over a time range.

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/data/export

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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.export.

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

{
  "email": "export@example.com",
  "deviceIds": [
    "575ecf887ae143cd83dc4aa2",
    "575ef5c97ae143cd83dc4aac"
  ],
  "attributes": [
    "voltage"
  ],
  "end": 0,
  "options": {
    "includeDate": false,
    "includeID": true
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"email":"export@example.com","deviceIds":["575ecf887ae143cd83dc4aa2","575ef5c97ae143cd83dc4aac"],"attributes":["voltage"],"end":0,"options":{"includeDate":false,"includeID":true}}' \
    https://api.losant.com/applications/APPLICATION_ID/data/export

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	If command was successfully sent

Error Responses

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

Last Value Query

Returns the last known data for the given attribute

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/data/last-value-query

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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.lastValueQuery.

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

{
  "deviceIds": [
    "575ecf887ae143cd83dc4aa2",
    "575ef5c97ae143cd83dc4aac"
  ],
  "attribute": "voltage"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"deviceIds":["575ecf887ae143cd83dc4aa2","575ef5c97ae143cd83dc4aac"],"attribute":"voltage"}' \
    https://api.losant.com/applications/APPLICATION_ID/data/last-value-query

Successful Responses

Code	Type	Description
200	Last Value Data	Last known data for the requested attribute

Error Responses

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

Time Series Query

Returns the data for the given query

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/data/time-series-query

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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.timeSeriesQuery.

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

{
  "end": 0,
  "duration": 600000,
  "resolution": 300000,
  "aggregation": "MEAN",
  "attributes": [
    "voltage"
  ],
  "deviceTags": [
    {
      "key": "floor",
      "value": "8"
    }
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"end":0,"duration":600000,"resolution":300000,"aggregation":"MEAN","attributes":["voltage"],"deviceTags":[{"key":"floor","value":"8"}]}' \
    https://api.losant.com/applications/APPLICATION_ID/data/time-series-query

Successful Responses

Code	Type	Description
200	Time Series Data	Data for requested time range

Error Responses

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

Schemas

Devices Data Export

Schema for exporting the data for multiple devices

Devices Data Export Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
email:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
deviceIds:{} 3 keys
▶
deviceTags:{} 3 keys
▶
deviceQuery:{} 5 keys
▶
attributes:{} 3 keys
▶
start:{} 1 key
▶
end:{} 1 key
▶
options:{} 2 keys
additionalProperties:false

Devices Data Export Example

▶
root:{} 5 keys
email:"export@example.com"
▶
deviceIds:[] 2 items
▶
attributes:[] 1 item
end:0
▶
options:{} 2 keys

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

Last Value Data

Schema for the result of a last value query

Last Value Data Schema

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

Last Value Data Example

▶
root:{} 2 keys
▶
575ecf887ae143cd83dc4aa2:{} 2 keys
▶
575ef5c97ae143cd83dc4aac:{} 2 keys

Last Value Query

Schema for the body of a last value query request

Last Value Query Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
attribute:{} 2 keys
▶
deviceIds:{} 3 keys
▶
deviceTags:{} 3 keys
▶
deviceQuery:{} 5 keys
▶
end:{} 1 key
additionalProperties:false

Last Value Query Example

▶
root:{} 2 keys
▶
deviceIds:[] 2 items
attribute:"voltage"

Time Series Data

Schema for the result of a time series query

Time Series Data Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
resolution:{} 1 key
▶
aggregation:{} 1 key
▶
limit:{} 1 key
▶
order:{} 2 keys
▶
devices:{} 3 keys
additionalProperties:false
▶
required:[] 7 items

Time Series Data Example

▶
root:{} 7 keys
start:"2016-06-15T03:50:00.000Z"
end:"2016-06-15T04:00:00.000Z"
resolution:300000
aggregation:"MEAN"
limit:null
order:"asc"
▶
devices:{} 2 keys

Time Series Query

Schema for the body of a time series query request

Time Series Query Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
start:{} 1 key
▶
end:{} 1 key
▶
duration:{} 1 key
▶
resolution:{} 1 key
▶
aggregation:{} 1 key
▶
attributes:{} 2 keys
▶
deviceIds:{} 3 keys
▶
deviceTags:{} 3 keys
▶
deviceQuery:{} 5 keys
▶
limit:{} 1 key
▶
order:{} 3 keys
additionalProperties:false

Time Series Query Example

▶
root:{} 6 keys
end:0
duration:600000
resolution:300000
aggregation:"MEAN"
▶
attributes:[] 1 item
▶
deviceTags:[] 1 item