Instance Actions

https://api.losant.com/instances/INSTANCE_ID

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

Device Counts

Returns device counts by day for the time range specified for this instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/deviceCounts

Authentication

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

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for device count query (ms since epoch)		start=0
end	N	End of range for device count query (ms since epoch)		end=1465790400000

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/instances/INSTANCE_ID/deviceCounts

Successful Responses

Code	Type	Description
200	Device Counts	Device counts by day

Error Responses

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

Generate Report

Generates a CSV report on instance stats

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/generateReport

Authentication

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

Request Path Components

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

{
  "email": "email@example.com",
  "callbackUrl": "https://example.com/callback",
  "resourceGroupBy": "organization",
  "dateGroupBy": "month",
  "includeSandbox": false,
  "start": "2020-01-01T00:00:00.000Z",
  "end": "2020-01-31T11:59:59.999Z"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.losant.com/instances/INSTANCE_ID/generateReport

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	If generation of report was successfully started

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Get

Returns an instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

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/instances/INSTANCE_ID

Successful Responses

Code	Type	Description
200	Instance	A single instance

Error Responses

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

Historical Summaries

Return historical summary entries for an instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/historicalSummaries

Authentication

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

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
month	N	Timestamp within the month to report a summary for.	now	month=1609459204518
sortField	N	Field to sort the results by. Accepted values are: resourceId, currentPeriodStart	currentPeriodStart	sortField=resourceId
sortDirection	N	Direction to sort the results in. 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: resourceType, resourceId, ownerId, ownerType		filterField=resourceType
filter	N	Filter to apply against the filtered field. Blank or not provided means no filtering.		filter=organization

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/instances/INSTANCE_ID/historicalSummaries

Successful Responses

Code	Type	Description
200	Historical Summaries	Collection of historical summaries

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Notebook Minute Counts

Returns notebook execution usage by day for the time range specified for this instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/notebookMinuteCounts

Authentication

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

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for notebook execution query (ms since epoch)		start=0
end	N	End of range for notebook execution query (ms since epoch)		end=1465790400000

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/instances/INSTANCE_ID/notebookMinuteCounts

Successful Responses

Code	Type	Description
200	Notebook Minute Counts	Notebook usage information

Error Responses

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

Patch

Updates information about an instance

Method And Url

PATCH https://api.losant.com/instances/INSTANCE_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.Instance, all.User, instance.*, or instance.patch.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	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 Instance Patch schema. For example, the following would be a valid body for this request:

{
  "reportConfigs": [
    {
      "emails": [
        "email@example.com"
      ],
      "callbackUrl": "https://example.com/callback",
      "resourceGroupBy": "organization",
      "dateGroupBy": "month",
      "includeSandbox": false,
      "periods": 3,
      "cron": "0 4 1 * *"
    },
    {
      "emails": [
        "email@example.com",
        "anotheremail@example.com"
      ],
      "resourceGroupBy": "application",
      "dateGroupBy": "month",
      "includeSandbox": true,
      "cron": "0 4 1 * *"
    }
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"reportConfigs":[{"emails":["email@example.com"],"callbackUrl":"https://example.com/callback","resourceGroupBy":"organization","dateGroupBy":"month","includeSandbox":false,"periods":3,"cron":"0 4 1 * *"},{"emails":["email@example.com","anotheremail@example.com"],"resourceGroupBy":"application","dateGroupBy":"month","includeSandbox":true,"cron":"0 4 1 * *"}]}' \
    https://api.losant.com/instances/INSTANCE_ID

Successful Responses

Code	Type	Description
200	Instance	The updated instance object

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Payload Counts

Returns payload counts for the time range specified for this instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/payloadCounts

Authentication

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

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=true

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/instances/INSTANCE_ID/payloadCounts

Successful Responses

Code	Type	Description
200	Payload Stats	Payload counts, by type and source

Error Responses

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

Payload Counts Breakdown

Returns payload counts per resolution in the time range specified for this instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/payloadCountsBreakdown

Authentication

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

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
resolution	N	Resolution in milliseconds. Accepted values are: 86400000, 3600000	86400000	resolution=86400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=true
includeNonBillable	N	If non-billable payloads should be included in the result	false	includeNonBillable=true

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/instances/INSTANCE_ID/payloadCountsBreakdown

Successful Responses

Code	Type	Description
200	Payload Counts Breakdown	Sum of payload counts by date

Error Responses

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

Schemas

Device Counts

Schema for the result of a device counts request

Device Counts Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Device Counts Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

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"

Historical Summaries

Schema for a collection of Historical Summaries

Historical Summaries Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 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

Historical Summaries Example

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

Instance

Schema for a single Instance

Instance Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
name:{} 3 keys
▶
id:{} 2 keys
▶
instanceId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
allowAuditLogging:{} 1 key
▶
reportConfigs:{} 3 keys
▶
limits:{} 3 keys
▶
orgDefaultLimitConfig:{} 3 keys
▶
members:{} 2 keys
▶
mfaMode:{} 2 keys

Instance Example

▶
root:{} 8 keys
name:"B"
▶
limits:{} 31 keys
▶
members:[] 3 items
creationDate:"2021-01-08T18:10:00.054Z"
lastUpdated:"2021-01-08T18:10:00.054Z"
allowAuditLogging:false
instanceId:"5ff89ff825013dc6c2856188"
id:"5ff89ff825013dc6c2856188"

Instance Patch

Schema for instance patch request

Instance Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
reportConfigs:{} 3 keys
▶
orgDefaultLimitConfig:{} 3 keys
▶
mfaMode:{} 2 keys
additionalProperties:false

Instance Patch Example

▶
root:{} 1 key
▶
reportConfigs:[] 2 items

Instance Report Options Post

Schema for the body of a instance report request

Instance Report Options Post Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
email:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
resourceGroupBy:{} 2 keys
▶
dateGroupBy:{} 2 keys
▶
includeSandbox:{} 1 key
▶
start:{} 2 keys
▶
end:{} 2 keys
additionalProperties:false

Instance Report Options Post Example

▶
root:{} 7 keys
email:"email@example.com"
callbackUrl:"https://example.com/callback"
resourceGroupBy:"organization"
dateGroupBy:"month"
includeSandbox:false
start:"2020-01-01T00:00:00.000Z"
end:"2020-01-31T11:59:59.999Z"

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

Notebook Minute Counts

Schema for the result of a notebook minute counts request

Notebook Minute Counts Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Notebook Minute Counts Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Counts Breakdown

Schema for the result of a payload counts breakdown request

Payload Counts Breakdown Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Payload Counts Breakdown Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Stats

Schema for the result of a payload stats request

Payload Stats Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
appFile:{} 2 keys
▶
dataTable:{} 2 keys
▶
deviceCreate:{} 2 keys
▶
deviceCommand:{} 2 keys
▶
deviceConnect:{} 2 keys
▶
deviceDisconnect:{} 2 keys
▶
deviceState:{} 2 keys
▶
endpoint:{} 2 keys
▶
event:{} 2 keys
▶
flowError:{} 2 keys
▶
inboundEmail:{} 2 keys
▶
integration:{} 2 keys
▶
mqttIn:{} 2 keys
▶
mqttOut:{} 2 keys
▶
notebook:{} 2 keys
▶
resourceJob:{} 2 keys
▶
timer:{} 2 keys
▶
virtualButton:{} 2 keys
▶
webhook:{} 2 keys

Payload Stats Example

▶
root:{} 6 keys
▶
timer:{} 1 key
▶
deviceState:{} 2 keys
▶
mqttOut:{} 1 key
▶
webhook:{} 1 key
▶
deviceConnect:{} 1 key
▶
deviceDisconnect:{} 1 key