Events Actions

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

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

Delete

Delete events

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/events/delete

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.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.delete.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
email	N	Email address to send job complete notification to. Defaults to current user's email.		email=email@example.com
callbackUrl	N	Callback URL to call with delete result		callbackUrl=https://example.com/cburl

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

{
  "$or": [
    {
      "level": {
        "$ne": "myValue"
      }
    },
    {
      "level": 5
    }
  ]
}

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/applications/APPLICATION_ID/events/delete

Successful Responses

Code	Type	Description
200	Events Deleted	If request successfully deletes a set of Events
202	Job Enqueued API Result	If a bulk delete job has been enqueued

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if events were not found

Export

Request an export of an application's event data

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/events/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.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.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 Event Export Options schema. For example, the following would be a valid body for this request:

{
  "email": "email@example.com",
  "query": {
    "$or": [
      {
        "subject": {
          "$ne": "myValue"
        }
      },
      {
        "level": "info"
      }
    ]
  }
}

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/applications/APPLICATION_ID/events/export

Successful Responses

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

Error Responses

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

Get

Returns the events for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/events

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.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.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: subject, id, creationDate, lastUpdated, level, state, deviceId	creationDate	sortField=subject
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	desc	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: subject		filterField=subject
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=abnormal power to *
state	N	If provided, return events only in the given state. Accepted values are: new, acknowledged, resolved		state=new
query	N	Event filter JSON object which overrides the filterField, filter, and state parameters. See Advanced Event Query for more details.		query={"$or":[{"level":{"$ne":"myValue"}},{"level":5}]}

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/events

Successful Responses

Code	Type	Description
200	Events	Collection of events

Error Responses

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

Most Recent by Severity

Returns the first new event ordered by severity and then creation

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/events/mostRecentBySeverity

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.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.mostRecentBySeverity.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
filter	N	Filter to apply against event subjects. Supports globbing. Blank or not provided means no filtering.		filter=abnormal power to *
query	N	Event filter JSON object which overrides the filter parameter. See Advanced Event Query for more details.		query={"$or":[{"level":{"$ne":"myValue"}},{"level":5}]}

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/events/mostRecentBySeverity

Successful Responses

Code	Type	Description
200	Event Plus New Count	The event, plus count of currently new events

Error Responses

Code	Type	Description
404	Error	Error if application was not found

Patch

Asynchronously updates information for matching events by subject and/or current state

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/events

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.Organization, all.User, events.*, or events.patch.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
filterField	N	Field to filter the events to act on by. Blank or not provided means no filtering. Accepted values are: subject		filterField=subject
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=abnormal power to *
state	N	If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved		state=new
query	N	Event filter JSON object which overrides the filterField, filter, and state parameters. See Advanced Event Query for more details.		query={"$or":[{"level":{"$ne":"myValue"}},{"level":5}]}

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

{
  "state": "acknowledged",
  "comment": "Looking into this issue"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"state":"acknowledged","comment":"Looking into this issue"}' \
    https://api.losant.com/applications/APPLICATION_ID/events

Successful Responses

Code	Type	Description
200	Success	If the bulk update has been completed
202	Job Enqueued API Result	If a bulk update job has been enqueued

Error Responses

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

Post

Create a new event for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/events

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.Organization, all.User, events.*, or events.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 Event Post schema. For example, the following would be a valid body for this request:

{
  "level": "info",
  "state": "new",
  "subject": "Power levels critical",
  "message": "Power levels on device 432 have surpassed critical thresholds",
  "deviceId": "575ecf887ae143cd83dc4aa2"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"level":"info","state":"new","subject":"Power levels critical","message":"Power levels on device 432 have surpassed critical thresholds","deviceId":"575ecf887ae143cd83dc4aa2"}' \
    https://api.losant.com/applications/APPLICATION_ID/events

Successful Responses

Code	Type	Description
201	Event	Successfully created event

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found
429	Error	Error if event creation rate limit exceeded

Schemas

Advanced Event Query

Schema for advanced event queries

Advanced Event Query Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 15 keys
▶
$and:{} 3 keys
▶
$or:{} 3 keys
▶
$nor:{} 3 keys
▶
id:{} 1 key
▶
creationDate:{} 1 key
▶
lastUpdated:{} 1 key
▶
sourceId:{} 1 key
▶
sourceType:{} 1 key
▶
level:{} 1 key
▶
state:{} 1 key
▶
subject:{} 1 key
▶
deviceId:{} 1 key
▶
experienceUserId:{} 1 key
▶
experienceGroupId:{} 1 key
▶
eventTags:{} 1 key
additionalProperties:false

Advanced Event Query Example

▶
root:{} 1 key
▶
$or:[] 2 items

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"

Event

Schema for a single Event

Event Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 17 keys
▶
id:{} 2 keys
▶
eventId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
sourceType:{} 2 keys
▶
sourceId:{} 2 keys
▶
sourceName:{} 3 keys
▶
level:{} 2 keys
▶
state:{} 2 keys
▶
subject:{} 3 keys
▶
message:{} 2 keys
data:{} 0 keys
▶
deviceId:{} 2 keys
▶
deviceName:{} 3 keys
▶
eventTags:{} 3 keys
▶
updates:{} 2 keys

Event Example

▶
root:{} 16 keys
id:"575ed0de7ae143cd83dc4aa5"
eventId:"575ed0de7ae143cd83dc4aa5"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
sourceType:"user"
sourceId:"575ed70c7ae143cd83dc4aa9"
sourceName:"hello@example.com"
level:"info"
state:"new"
subject:"Power levels critical"
message:"Power levels on device 432 have surpassed critical thresholds"
updates:[] 0 items
deviceId:"575ecf887ae143cd83dc4aa2"
deviceName:"My Device"
▶
eventTags:{} 1 key

Event Patch

Schema for the body of an Event modification request

Event Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys
▶
state:{} 2 keys
▶
comment:{} 2 keys
data:{} 0 keys
▶
eventTags:{} 3 keys
additionalProperties:false

Event Patch Example

▶
root:{} 2 keys
state:"acknowledged"
comment:"Looking into this issue"

Event Plus New Count

Schema for an event plus a count of new events

Event Plus New Count Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
event:{} 4 keys
▶
newCount:{} 1 key

Event Plus New Count Example

▶
root:{} 2 keys
▶
event:{} 16 keys
newCount:2

Event Post

Schema for the body of an Event creation request

Event Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
level:{} 2 keys
▶
state:{} 2 keys
▶
subject:{} 3 keys
▶
message:{} 2 keys
data:{} 0 keys
▶
deviceId:{} 2 keys
▶
eventTags:{} 3 keys
▶
creationDate:{} 1 key
▶
required:[] 2 items
additionalProperties:false

Event Post Example

▶
root:{} 5 keys
level:"info"
state:"new"
subject:"Power levels critical"
message:"Power levels on device 432 have surpassed critical thresholds"
deviceId:"575ecf887ae143cd83dc4aa2"

Events

Schema for a collection of Events

Events Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 12 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
▶
state:{} 2 keys
▶
applicationId:{} 2 keys
▶
query:{} 1 key

Events Example

▶
root:{} 9 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"subject"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"
state:"new"

Events Deleted

Schema for response to events removal

Events Deleted Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
removed:{} 1 key

Events Deleted Example

▶
root:{} 1 key
removed:3

Event Export Options

Export options for events

Event Export Options Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
email:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
query:{} 5 keys
additionalProperties:false

Event Export Options Example

▶
root:{} 2 keys
email:"email@example.com"
▶
query:{} 1 key

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