Route Logs API

The Notehub route logs API provides RESTful methods that can be used to GET Notehub route logs by event or by route.

Get Route Logs by Event

Get an array of route logs associated with a Notehub project by event UID.

Minimum Notehub project-level role required:

Arguments

`access_token`

string

A Notehub API bearer token.

`projectUID`

string

The ProjectUID from a Notehub project.

`eventUID`

string

The eventUID from a Notehub project's event.

Bash

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/events/<eventUID>/route-logs'
    -H 'Authorization: Bearer <access_token>'

Response Members

`date`

string

The date/time stamp of the log entry.

`routeUID`

string

The globally-unique identifier of the route.

`eventUID`

string

The globally-unique identifier of the event.

`attn`

boolean

Whether the event was routed in error.

`status`

string

The status of the event.

`text`

string

The response body of the route.

Example Response

JSON

[
  {
      "date": "2023-08-07T17:29:21.677934Z",
      "routeUID": "app:4be5d3ac-998a-44f0-8ecd-6bd716858b3c/route:d632e16fc956162ae3db4f20ddacc2b1",
      "eventUID": "cccd9b22-b156-47ee-b399-bf7e1c45d5f0",
      "attn": false,
      "status": "200",
      "text": "thanks"
  }
]

Get Route Logs by Route

Get an array of route logs associated with a Notehub project.

Minimum Notehub project-level role required:

Arguments

`access_token`

string

A Notehub API bearer token.

`projectUID`

string

The ProjectUID from a Notehub project.

`routeUID`

string

The routeUID from a Notehub project.

`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).

`deviceUID`

string (optional)

The DeviceUID of a Notehub device.

You may alternatively provide a device serial number by prefixing this argument with sn:, for example sn:my-device.

`sortBy`

string (optional)

Specifies a field in the result set to sort by, and must be one of the following: best_id, device_serial, device_uid, captured, modified, device_location, tower_location, triangulated_location, best_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.

`systemFilesOnly`

boolean (optional)

If true, will only return System Notefiles in the response.

`files`

string (optional)

A comma-delimited list of Notefile(s) this request should return events from. For example, setting this argument to track.qo,sensor.qo would return events only from the track.qo and sensor.qo Notefiles.

Basic

Bash

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/routes/<routeUID>/route-logs'
    -H 'Authorization: Bearer <access_token>'

Optional Params

Bash

curl -X GET
     -L 'https://api.notefile.net/v1/projects/<projectUID>/routes/<routeUID>/route-logs?pageSize={pageSize}&pageNum={pageNum}&deviceUID={deviceUID}&sortBy={sortBy}&sortOrder={sortOrder}&startDate={startDate}&endDate={endDate}&systemFilesOnly={systemFilesOnly}&files={files}'
     -H 'Authorization: Bearer <access_token>'

Response Members

`date`

string

The date/time stamp of the log entry.

`routeUID`

string

The globally-unique identifier of the route.

`eventUID`

string

The globally-unique identifier of the event.

`attn`

boolean

Whether the event was routed in error.

`status`

string

The status of the event.

`text`

string

The response body of the route.

Example Response

JSON

[
  {
      "date": "2023-05-06T05:40:51.80559Z",
      "routeUID": "app:4be5d3ac-998a-44f0-8ecd-6bd716858b3d/route:d632e16fc956162ae3db4f20ddacc2b8",
      "eventUID": "5ee2e385-e282-476e-afec-327498fe91a3",
      "attn": false,
      "status": "200",
      "text": "thanks"
  },
  {
      "date": "2023-05-06T05:40:51.318522Z",
      "routeUID": "app:4be5d3ac-998a-44f0-8ecd-6bd716858b3d/route:d632e16fc956162ae3db4f20ddacc2b8",
      "eventUID": "4fb2c905-080a-40c5-96f7-d8193fa18116",
      "attn": false,
      "status": "200",
      "text": "thanks"
  }
]

Route API