Rate this page

★
★
★
★
★
★
★
★
★
★

Event API

The Notehub event API provides RESTful methods that can be used to GET event data.

Get Events by Project

Get an array of Notehub events by ProjectUID.

Minimum Notehub project-level role required:

Arguments

`authToken`

string

A Notehub API authentication token.

`projectUID`

string

The ProjectUID from a Notehub project.

`pageSize`

integer (optional)

Specifies the number of events to be returned by a request (default 50).

`since`

string (optional)

The UID of the last event retrieved by a previous query, obtained from the through value from a previous call. This event will not be included in the retrieved result set, but everything that's arrived later will be included.

`deviceUIDs`

string (optional)

A comma-separated list of DeviceUIDs.

`sortBy`

string (optional)

Specifies a field in the result set to sort by (e.g. device_serial, device_uid, captured, received, device_location, tower_location, triangulated_location).

`sortOrder`

string (optional)

Specifies the ascending (asc) or descending (desc) order of the result set when paired with sortBy. The default is asc.

`startDate`

UNIX Epoch time (optional)

The start date/time stamp of the events to be returned.

`endDate`

UNIX Epoch time (optional)

The end date/time stamp of the events to be returned.

Response Members

`uid`

string

The globally-unique identifier of the event.

`device_uid`

string

The globally-unique identifier of the device.

`file`

string

The name of the Notefile.

`captured`

string

The date and time this event was captured by the device.

`received`

string

The date and time this event was received by Notehub.

`body`

object

A JSON object containing the event details.

`tower_location`

object

An object containing information about the physical location of the cell tower used to receive the event.

`gps_location`

object

An object containing information about the physical location of the device that sent the event based on GPS coordinates.

`through`

string

The globally-unique identifier of the last event in the array.

`has_more`

boolean

Defines whether or not there are additional events beyond this list.

Example Response


{
   "events":[
      {
         "uid":"00000000-0000-0000-0000-000000000000",
         "device_uid":"dev:000000000000000",
         "file":"data.qo",
         "captured":"2021-04-26T19:13:46Z",
         "received":"2021-04-26T19:13:46Z",
         "body":{
            "temperature":54.3
         },
         "tower_location":{
            "when":"2021-04-26T19:13:46Z",
            "name":"Shorewood Hills WI",
            "country":"US",
            "timezone":"America/Chicago",
            "latitude":43.073787499999995,
            "longitude":-89.44367187499999
         },
          "gps_location":{
            "same properties as tower_location"
          },
      }
   ],
   "through":"00000000-0000-0000-0000-000000000000",
   "has_more":false
}

Get Events by Cursor

Get an array of Notehub events by ProjectUID and cursor (i.e. a means of limiting your result set).

Minimum Notehub project-level role required:

Arguments

`authToken`

string

A Notehub API authentication token.

`projectUID`

string

The ProjectUID from a Notehub project.

`limit`

integer (optional)

The number of records to return (minimum value is 1). Default value is 50.

`cursor`

string (optional)

The globally-unique EventUID obtained from the next_cursor value from a previous call to this API. The result set will include this event as its first result. However, if the provided EventUID is not valid, this parameter is ignored.

`sortOrder`

string (optional)

Specifies the ascending (asc) or descending (desc) order of the result set based on the timestamp at which the event was received in Notehub. The default is asc.


curl -X GET
     -L 'https://api.notefile.net/v1/projects/{projectUID}/events-cursor?limit={limit}&cursor={cursor}&sortOrder={sortOrder}'
     -H 'X-SESSION-TOKEN: {authToken}'

Response Members

`uid`

string

The globally-unique EventUID.

`device_uid`

string

The globally-unique identifier of the device.

`file`

string

The name of the Notefile.

`captured`

string

The date and time this event was captured by the device.

`received`

string

The date and time this event was received by Notehub.

`body`

object

A JSON object containing the event details.

`tower_location`

object

An object containing information about the physical location of the cell tower used to receive the event.

`gps_location`

object

An object containing information about the physical location of the device that sent the event based on GPS coordinates.

`next_cursor`

string

The cursor value of the next EventUID, which is intended to be used as the cursor parameter of the subsequent call to this API. An empty string is returned if there are no additional results to display.

`has_more`

boolean

Defines whether or not there are additional events beyond this list.

Example Response


{
   "events":[
      {
         "uid":"00000000-0000-0000-0000-000000000000",
         "device_uid":"dev:000000000000000",
         "file":"data.qo",
         "captured":"2021-04-26T19:13:46Z",
         "received":"2021-04-26T19:13:46Z",
         "body":{
            "temperature":54.3
         },
         "tower_location":{
            "when":"2021-04-26T19:13:46Z",
            "name":"Shorewood Hills WI",
            "country":"US",
            "timezone":"America/Chicago",
            "latitude":43.073787499999995,
            "longitude":-89.44367187499999
         },
          "gps_location":{
            "same properties as tower_location"
          },
      }
   ],
   "next_cursor":"00000000-0000-0000-0000-000000000000",
   "has_more":false
}

Get Latest Events

Get the most recent health log, session, and note events by ProjectUID and DeviceUID (updated at the end of every session). If a device is in continuous mode, the latest events are updated every 15 minutes.

Minimum Notehub project-level role required:

Arguments

`authToken`

string

A Notehub API authentication token.

`projectUID`

string

The ProjectUID from a Notehub project.

`deviceUID`

string

The DeviceUID of a Notehub device.


curl -X GET
     -L 'https://api.notefile.net/v1/projects/{projectUID}/devices/{deviceUID}/latest'
     -H 'X-SESSION-TOKEN: {authToken}'

Response Members

`file`

string

The name of the Notefile.

`captured`

string

The date and time this event was captured by the device.

`received`

string

The date and time this event was received by Notehub.

`event_uid`

string

The globally unique identifier of the event.

`body`

object

A JSON object containing the event details.

Example Response


{
  "latest_events": [
    {
      "file": "_health.qo",
      "captured": "2021-04-27T15:37:47Z",
      "received": "2021-04-27T15:37:58Z",
      "event_uid": "00000000-0000-0000-0000-000000000000",
      "body": {
        "text": "boot (brown-out \u0026 hard reset [12460])"
      }
    },
    {
      "file": "_session.qo",
      "captured": "2021-04-27T15:37:55Z",
      "received": "2021-04-27T15:37:55Z",
      "event_uid": "00000000-0000-0000-0000-000000000000",
      "body": {
        "why": "first sync, continuous connection mode (TLS)"
      }
    },
    {
      "file": "data.qo",
      "captured": "2021-04-26T19:13:23Z",
      "received": "2021-04-26T19:13:49Z",
      "event_uid": "00000000-0000-0000-0000-000000000000",
      "body": {
        "temperature": 54.3
      }
    }
  ]
}

Get Health Log

Get an array of health log events by ProjectUID and DeviceUID.

Minimum Notehub project-level role required:

Arguments

`authToken`

string

A Notehub API authentication token.

`projectUID`

string

The ProjectUID from a Notehub project.

`deviceUID`

string

The DeviceUID of a Notehub device.


curl -X GET
     -L 'https://api.notefile.net/v1/projects/{projectUID}/devices/{deviceUID}/health-log'
     -H 'X-SESSION-TOKEN: {authToken}'

Response Members

`when`

string

The date and time this event was received by Notehub.

`alert`

boolean

The date and time this event was received by Notehub.

`text`

string

Descriptive information about the health log event.

Example Response


{
  "health_log": [
    {
      "when": "2021-04-27T15:37:47Z",
      "alert": false,
      "text": "boot (brown-out \u0026 hard reset [12460])"
    }
  ]
}

Get Sessions

Get all session events by ProjectUID and DeviceUID.

Minimum Notehub project-level role required:

Arguments

`authToken`

string

A Notehub API authentication token.

`projectUID`

string

The ProjectUID from a Notehub project.

`deviceUID`

string

The DeviceUID of a Notehub device.

`pageSize`

integer (optional)

Specifies the number of sessions to be returned by a request (default 50).

`pageNum`

integer (optional)

Specifies the page number of the results returned (useful when the pageSize is less than the total number of sessions that could be returned).

Response Members

`started`

string

The start date/time stamp of the session.

`duration`

integer

The duration of the session in seconds.

`notes`

integer

The number of Notes sent and received during the session.

`bytes`

integer

The approximate number of bytes sent and received during the session.

`tower_location.when`

string

The time the network session was established.

`tower_location.name`

string

The location of the cell tower.

`tower_location.country`

string

The two-digit country code of the cell tower.

`tower_location.timezone`

string

The timezone of the cell tower.

`tower_location.latitude`

decimal

The latitude of the cell tower.

`tower_location.longitude`

decimal

The longitude of the cell tower.

`has_more`

boolean

Whether or not there are additional sessions to display.

Example Response


{
   "sessions":[
      {
         "started":"2022-04-03T15:02:20Z",
         "duration":1,
         "notes":1,
         "bytes":373,
         "tower_location":{
            "when":"2022-04-03T15:02:20Z",
            "name":"Shorewood Hills WI",
            "country":"US",
            "timezone":"America/Chicago",
            "latitude":43.073787499999995,
            "longitude":-89.44367187499999
         }
      }
   ],
   "has_more":true
}

Get Events by Fleet

Get an array of Notehub events by FleetUID.

Minimum Notehub project-level role required:

Arguments

`authToken`

string

A Notehub API authentication token.

`projectUID`

string

The ProjectUID from a Notehub project.

`fleetUID`

string

The FleetUID from a device fleet.

`pageSize`

integer (optional)

Specifies the number of events to be returned by a request (default 50).

`pageNum`

integer (optional)

Specifies the page number of the results returned (useful when the pageSize is less than the total number of sessions that could be returned).

`deviceUIDs`

string (optional)

A comma-separated list of DeviceUIDs.

`sortBy`

string (optional)

Specifies a field in the result set to sort by (e.g. device_serial, device_uid, captured, received, device_location, tower_location, triangulated_location).

`sortOrder`

string (optional)

Specifies the ascending (asc) or descending (desc) order of the result set when paired with sortBy. The default is asc.

`startDate`

UNIX Epoch time (optional)

The start date/time stamp of the events to be returned.

`endDate`

UNIX Epoch time (optional)

The end date/time stamp of the events to be returned.

Response Members

`uid`

string

The globally-unique identifier of the event.

`device_uid`

string

The globally-unique identifier of the device.

`file`

string

The name of the Notefile.

`captured`

string

The date and time this event was captured by the device.

`received`

string

The date and time this event was received by Notehub.

`body`

object

A JSON object containing the event details.

`tower_location`

object

An object containing information about the physical location of the cell tower used to receive the event.

`gps_location`

object

An object containing information about the physical location of the device that sent the event based on GPS coordinates.

`through`

string

The globally-unique identifier of the last event in the array.

`has_more`

boolean

Defines whether or not there are additional events beyond this list.

Example Response


{
   "events":[
      {
         "uid":"00000000-0000-0000-0000-000000000000",
         "device_uid":"dev:000000000000000",
         "file":"data.qo",
         "captured":"2021-04-26T19:13:46Z",
         "received":"2021-04-26T19:13:46Z",
         "body":{
            "temperature":54.3
         },
         "tower_location":{
            "when":"2021-04-26T19:13:46Z",
            "name":"Shorewood Hills WI",
            "country":"US",
            "timezone":"America/Chicago",
            "latitude":43.073787499999995,
            "longitude":-89.44367187499999
         },
          "gps_location":{
            "same properties as tower_location"
          },
      }
   ],
   "through":"00000000-0000-0000-0000-000000000000",
   "has_more":false
}

Get Fleet Events by Cursor

Get an array of Notehub events by FleetUID and cursor (i.e. a means of limiting your result set).

Minimum Notehub project-level role required:

Arguments

`authToken`

string

A Notehub API authentication token.

`projectUID`

string

The ProjectUID from a Notehub project.

`fleetUID`

string

The FleetUID from a device fleet.

`limit`

integer (optional)

The number of records to return (minimum value is 1). Default value is 50.

`cursor`

string (optional)

`sortOrder`

string (optional)

Specifies the ascending (asc) or descending (desc) order of the result set based on the timestamp at which the event was received in Notehub. The default is asc.


curl -X GET
     -L 'https://api.notefile.net/v1/projects/{projectUID}/fleets/{fleetUID}/events-cursor?limit={limit}&cursor={cursor}&sortOrder={sortOrder}'
     -H 'X-SESSION-TOKEN: {authToken}'

Response Members

`uid`

string

The globally-unique identifier of the event.

`device_uid`

string

The globally-unique identifier of the device.

`file`

string

The name of the Notefile.

`captured`

string

The date and time this event was captured by the device.

`received`

string

The date and time this event was received by Notehub.

`body`

object

A JSON object containing the event details.

`tower_location`

object

An object containing information about the physical location of the cell tower used to receive the event.

`gps_location`

object

An object containing information about the physical location of the device that sent the event based on GPS coordinates.

`next_cursor`

string

The globally-unique identifier of the last event in the array.

`has_more`

boolean

Defines whether or not there are additional events beyond this list.

Example Response


{
   "events":[
      {
         "uid":"00000000-0000-0000-0000-000000000000",
         "device_uid":"dev:000000000000000",
         "file":"data.qo",
         "captured":"2021-04-26T19:13:46Z",
         "received":"2021-04-26T19:13:46Z",
         "body":{
            "temperature":54.3
         },
         "tower_location":{
            "when":"2021-04-26T19:13:46Z",
            "name":"Shorewood Hills WI",
            "country":"US",
            "timezone":"America/Chicago",
            "latitude":43.073787499999995,
            "longitude":-89.44367187499999
         },
          "gps_location":{
            "same properties as tower_location"
          },
      }
   ],
   "next_cursor":"00000000-0000-0000-0000-000000000000",
   "has_more":false
}

Environment Variable API File API