--- title: Event API - Notehub API Reference description: The Notehub event API provides RESTful methods that can be used to GET event data. source_url: https://dev.blues.io/api-reference/notehub-api/event-api/ canonical_url: https://dev.blues.io/api-reference/notehub-api/event-api/ markdown_url: https://dev.blues.io/api-reference/notehub-api/event-api.md --- # Event API The Notehub event API provides RESTful methods that can be used to `GET` event data. | Name | HTTP Request | | ------------------------------------------------------------- | ---------------------------------------------------------------------------- | | [Get Project Events](#get-project-events) | **GET** `/v1/projects/{projectOrProductUID}/events` | | [Get Project Events by Cursor](#get-project-events-by-cursor) | **GET** `/v1/projects/{projectOrProductUID}/events-cursor` | | [Get Fleet Events](#get-fleet-events) | **GET** `/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events` | | [Get Fleet Events by Cursor](#get-fleet-events-by-cursor) | **GET** `/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor` | | [Get Route Logs by Event](#get-route-logs-by-event) | **GET** `/v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs` | ## Get Project Events (Notehub) Get an array of Notehub events by [ProjectUID](https://dev.blues.io/api-reference/glossary.md#projectuid). | | | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/projects//events` | | Path Parameters: | - `projectOrProductUID` - The [ProjectUID](https://dev.blues.io/api-reference/glossary.md#projectuid) or [ProductUID](https://dev.blues.io/api-reference/glossary.md#productuid) of a Notehub project. | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | > **Note:** > > This API reference displays all possible fields that can be present in an event response. However, certain fields will only be present for certain types of events (e.g. Note added event, Note updated event, .dbs update event, Notehub session event, etc). Arguments ### `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). When provided, the `pageNum` must be >= `1`. ### `deviceUID` *Array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of DeviceUIDs of Notehub [devices](https://dev.blues.io/api-reference/glossary.md#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)* Start date for filtering results, specified as a Unix timestamp. ### `endDate` *UNIX Epoch time (optional)* End date for filtering results, specified as a Unix timestamp. ### `dateType` *string (optional)* Which date to filter on, either `captured` or `uploaded`. This will apply to the `startDate` and `endDate` parameters. ### `systemFilesOnly` *boolean (optional)* If `true`, will only return [System Notefiles](https://dev.blues.io/api-reference/system-notefiles.md) 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. ### `format` *string (optional)* Response format ("json" or "csv"). ### `serialNumber` *Array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of device [serial numbers](https://dev.blues.io/api-reference/glossary.md#serial-number) to filter by. ### `fleetUID` *Array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of [FleetUIDs](https://dev.blues.io/api-reference/glossary.md#fleetuid) to filter by. ### `sessionUID` *Array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of [SessionUIDs](https://dev.blues.io/api-reference/glossary.md#sessionuid) to filter by. ### `eventUID` *Array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of [EventUIDs](https://dev.blues.io/api-reference/glossary.md#eventuid) to filter by. ### `selectFields` *string (optional)* Comma-separated list of fields to include in the response (e.g., "field1,field2.subfield,field3"). **Basic** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//events' -H 'Authorization: Bearer ' ``` **JS** ```javascript import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure Bearer access token for authorization: personalAccessToken let personalAccessToken = defaultClient.authentications["personalAccessToken"]; personalAccessToken.accessToken = "YOUR ACCESS TOKEN"; let apiInstance = new NotehubJs.EventApi(); let projectOrProductUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String | let opts = { pageSize: 50, // Number | pageNum: 1, // Number | deviceUID: ["null"], // [String] | A Device UID. sortBy: "captured", // String | sortOrder: "asc", // String | startDate: 1628631763, // Number | Unix timestamp endDate: 1657894210, // Number | Unix timestamp dateType: "uploaded", // String | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters systemFilesOnly: true, // Boolean | files: "_health.qo, data.qo", // String | format: "json", // String | Response format (JSON or CSV) serialNumber: ["null"], // [String] | Filter by Serial Number fleetUID: ["null"], // [String] | Filter by Fleet UID sessionUID: ["null"], // [String] | Filter by Session UID eventUID: ["null"], // [String] | Filter by Event UID selectFields: "selectFields_example", // String | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. }; apiInstance.getEvents(projectOrProductUID, opts).then((data) => { console.log("API called successfully. Returned data: " + JSON.stringify(data)); }, (error) => { console.error(error); }); ``` **Python** ```python import notehub_py from notehub_py.models.get_events200_response import GetEvents200Response from notehub_py.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.notefile.net configuration = notehub_py.Configuration( host = "https://api.notefile.net" ) # Configure Bearer authorization: personalAccessToken configuration = notehub_py.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.EventApi(api_client) project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | page_size = 50 # int | (optional) (default to 50) page_num = 1 # int | (optional) (default to 1) device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) sort_by = "captured" # str | (optional) (default to "captured") sort_order = "asc" # str | (optional) (default to "asc") start_date = 1628631763 # int | Unix timestamp (optional) end_date = 1657894210 # int | Unix timestamp (optional) date_type = "captured" # str | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to 'captured') system_files_only = True # bool | (optional) files = "_health.qo, data.qo" # str | (optional) format = "json" # str | Response format (JSON or CSV) (optional) (default to 'json') serial_number = ["serial_number_example"] # List[str] | Filter by Serial Number (optional) fleet_uid = ["fleet_uid_example"] # List[str] | Filter by Fleet UID (optional) session_uid = ["session_uid_example"] # List[str] | Filter by Session UID (optional) event_uid = ["event_uid_example"] # List[str] | Filter by Event UID (optional) select_fields ="select_fields_example" # str | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional) try: api_response = api_instance.get_events(project_or_product_uid, page_size=page_size, page_num=page_num, device_uid=device_uid, sort_by=sort_by, sort_order=sort_order, start_date=start_date, end_date=end_date, date_type=date_type, system_files_only=system_files_only, files=files, format=format, serial_number=serial_number, fleet_uid=fleet_uid, session_uid=session_uid, event_uid=event_uid, select_fields=select_fields) print("The response of EventApi->get_events:\n") pprint(api_response) except Exception as e: print("Exception when calling EventApi->get_events: %s\n" % e) ``` **Optional Params** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//events?pageSize=&pageNum=&deviceUID=&sortBy=&sortOrder=&startDate=&endDate=&dateType=&systemFilesOnly=&files=&format=&serialNumber=&fleetUID=&sessionUID=&eventUID=&selectFields=' -H 'Authorization: Bearer ' ``` **Specific Notefiles** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//events?files=track.qo,sensor.qo' -H 'Authorization: Bearer ' ``` **Response Members** ### `event` *string* The globally-unique [EventUID](https://dev.blues.io/api-reference/glossary.md#eventuid). ### `session` *string* The globally-unique [SessionUID](https://dev.blues.io/api-reference/glossary.md#sessionuid) for the device's current Notehub session. ### `best_id` *string* The device's best identifier. This is the device's serial number if set, or the device's DeviceUID if not. ### `device` *string* The device's globally-unique [DeviceUID](https://dev.blues.io/api-reference/glossary.md#deviceuid). ### `sn` *string* The device's [serial number](https://dev.blues.io/api-reference/glossary.md#product-sn). ### `product` *string* The globally-unique [ProductUID](https://dev.blues.io/api-reference/glossary.md#productuid). ### `app` *string* The globally-unique [AppUID](https://dev.blues.io/api-reference/glossary.md#appuid) for the device's current Notehub application. ### `received` *UNIX Epoch time* The date and time this event was received by Notehub. ### `req` *string* The API command used to create this event. ### `when` *UNIX Epoch time* The date and time this event was captured by the device. ### `file` *string* The name of the [Notefile](https://dev.blues.io/api-reference/glossary.md#notefile). ### `updates` *integer* The number of updates performed on a DB Notefile. ### `body` *object* A JSON object containing the event details. ### `best_location_type` *string* The type of location used as for all the `"best"` response fields, either `"gps"`, `"triangulated"`, or `"tower"`. ### `best_location_when` *UNIX Epoch time* The date and time the device last determined its location. A device can have its location determined by GPS/GNSS, triangulation, or from the cell tower that received the event. The `best_*` fields provide the most accurate values from the available locations. ### `best_lat` *float* The latitude of the device that sent the event. A device can have its location determined by GPS/GNSS, triangulation, or from the cell tower that received the event. The `best_*` fields provide the most accurate values from the available locations. ### `best_lon` *float* The longitude of the device that sent the event. A device can have its location determined by GPS/GNSS, triangulation, or from the cell tower that received the event. The `best_*` fields provide the most accurate values from the available locations. ### `best_location` *string* The name of the location from the device that sent the event. A device can have its location determined by GPS/GNSS, triangulation, or from the cell tower that received the event. The `best_*` fields provide the most accurate values from the available locations. ### `best_country` *string* The country of the device that sent the event. A device can have its location determined by GPS/GNSS, triangulation, or from the cell tower that received the event. The `best_*` fields provide the most accurate values from the available locations. ### `best_timezone` *string* The timezone of the location from the device that sent the event. A device can have its location determined by GPS/GNSS, triangulation, or from the cell tower that received the event. The `best_*` fields provide the most accurate values from the available locations. ### `tower_id` *string* A combination of the `mcc`, `mnc`, `lac`, and `cid` values, denoting the cell tower where the session originated. ### `tower_country` *string* The country of the physical cell tower that received the event. ### `tower_lat` *float* The latitude of the physical cell tower that received the event. ### `tower_lon` *float* The longitude of the physical cell tower that received the event. ### `tower_location` *string* The name of the location of the physical cell tower that received the event. ### `tower_timezone` *string* The timezone used by the physical cell tower that received the event. ### `tower_when` *UNIX Epoch time* The date and time the device retrieved the tower location. ### `tri_when` *UNIX Epoch time* The date and time when the device retrieved its [triangulated location](https://dev.blues.io/notecard/notecard-walkthrough/time-and-location-requests.md#using-cell-tower-and-wifi-triangulation). ### `tri_lat` *float* The latitude of the device's [triangulated location](https://dev.blues.io/notecard/notecard-walkthrough/time-and-location-requests.md#using-cell-tower-and-wifi-triangulation) when it sent the event. ### `tri_lon` *float* The longitude of the device's [triangulated location](https://dev.blues.io/notecard/notecard-walkthrough/time-and-location-requests.md#using-cell-tower-and-wifi-triangulation) when it sent the event. ### `tri_location` *string* The name of the device's [triangulated location](https://dev.blues.io/notecard/notecard-walkthrough/time-and-location-requests.md#using-cell-tower-and-wifi-triangulation) when it sent the event. ### `tri_country` *string* The country of the device's [triangulated location](https://dev.blues.io/notecard/notecard-walkthrough/time-and-location-requests.md#using-cell-tower-and-wifi-triangulation) when it sent the event. ### `tri_timezone` *string* The timezone of the device's [triangulated location](https://dev.blues.io/notecard/notecard-walkthrough/time-and-location-requests.md#using-cell-tower-and-wifi-triangulation) when it sent the event. ### `tri_points` *integer* The number of WiFi access points (if using WiFi triangulation) or cell towers (if using cell-tower triangulation) used to determine the triangulated location. ### `where_country` *string* The country from the device's GPS/GNSS location when it sent the event. ### `where_lat` *float* The latitude from the device's GPS/GNSS location when it sent the event. ### `where_lon` *float* The longitude from the device's GPS/GNSS location when it sent the event. ### `where_location` *string* The name of the device's GPS/GNSS location when it sent the event. ### `where_timezone` *string* The timezone from the device's GPS/GNSS location when it sent the event. ### `where_when` *UNIX Epoch time* The date and time when the device last determined its GPS/GNSS location. ### `rssi` *integer* Received Signal Strength Indicator (RSSI) is an estimated measurement of how well a device can receive signals. Only available on `_session.qo` events. ### `sinr` *integer* The Signal to Interference plus Noise Ratio (SINR) of the cell tower that received the event. Only available on `_session.qo` events. ### `rsrp` *integer* The Reference Signal Received Power (RSRP) of the cell tower that received the event. Only available on `_session.qo` events. ### `rsrq` *integer* The Reference Signal Received Quality (RSRQ) of the cell tower that received the event. Only available on `_session.qo` events. ### `rat` *string* The Radio Access Technology (RAT) of the cell tower that received the event. Only available on `_session.qo` events. ### `bars` *integer* The number of signal bars of the cell tower that received the event. Only available on `_session.qo` events. ### `voltage` *float* The battery voltage of the device when it sent the event. Only available on `_session.qo` events. ### `temp` *float* The temperature of the device when it sent the event. Only available on `_session.qo` events. ### `sku` *string* The SKU of the device that sent the event. Only available on `_session.qo` events. ### `ordering_code` *string* The ordering code of the device that sent the event. Only available on `_session.qo` events. ### `ssid` *string* The Service Set Identifier (SSID) of the WiFi network the device was connected to when it sent the event. Only available on `_session.qo` events. ### `bssid` *string* The Basic Service Set Identifier (BSSID) of the WiFi network the device was connected to when it sent the event. Only available on `_session.qo` events. ### `has_more` *boolean* Defines whether or not there are additional events beyond this list. Example Response ```json { "events": [ { "event": "dfa3747d-688b-4250-935b-5dd60354313c", "session": "b623132c-6afb-4740-bc39-e3634e38f064", "best_id": "My Device", "device": "dev:5c0272311928", "sn": "My Device", "product": "product:com.blues.project.demo", "received": 1656011227.006928, "req": "note.add", "when": 1656010061, "file": "_session.qo", "updates": 1, "body": { "humidity": 40.375, "pressure": 97705.66, "temperature": 24.0625, "voltage": 2.598 }, "best_location_type": "triangulated", "best_location_when": 1652709545, "best_lat": 34.82476372, "best_lon": -83.32261614, "best_location": "Atlanta GA", "best_country": "US", "best_timezone": "America/New_York", "tower_when": 1652709545, "tower_lat": 34.82475372, "tower_lon": -83.32261614, "tower_location": "Atlanta GA", "tower_country": "US", "tower_timezone": "America/New_York", "tower_id": "0,0,0,0", "tri_when": 1652709545, "tri_lat": 34.82475372, "tri_lon": -83.32261614, "tri_location": "Atlanta GA", "tri_country": "US", "tri_timezone": "America/New_York", "tri_points": 6, "rssi": -63, "sinr": -2, "rsrp": -94, "rsrq": -15, "rat": "CAT-M1", "bars": 2, "voltage": 3.68, "temp": 32.25, "sku": "NOTE-NBGL", "ordering_code": "XBOXT1N5AFAB", "ssid": "My WiFi", "bssid": "00:11:22:33:44:55" } ], "has_more": false } ``` ## Get Project Events by Cursor (Notehub) Get an array of Notehub events by [ProjectUID](https://dev.blues.io/api-reference/glossary.md#projectuid) and cursor (i.e. a means of limiting your result set). | | | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/projects/{projectOrProductUID}/events-cursor` | | Path Parameters: | - `projectOrProductUID` - The [ProjectUID](https://dev.blues.io/api-reference/glossary.md#projectuid) or [ProductUID](https://dev.blues.io/api-reference/glossary.md#productuid) of a Notehub project. | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | > **Note:** > > This API reference displays all possible fields that can be present in an event response. However, certain fields will only be present for certain types of events (e.g. Note added event, Note updated event, .dbs update event, Notehub session event, etc). Arguments ### `fleetUID` *string (optional)* The FleetUID of a Notehub device [fleet](https://dev.blues.io/api-reference/glossary.md#fleet). ### `deviceUID` *array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of DeviceUIDs of Notehub [devices](https://dev.blues.io/api-reference/glossary.md#device). You may alternatively provide a device serial number by prefixing this argument with `sn:`, for example `sn:my-device`. ### `limit` *integer (optional)* The number of records to return (minimum value is `1`). Default value is `50`. ### `cursor` *string (optional)* The globally-unique [EventUID](https://dev.blues.io/api-reference/glossary.md#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`. ### `systemFilesOnly` *boolean (optional)* If `true`, will only return [System Notefiles](https://dev.blues.io/api-reference/system-notefiles.md) in the response. ### `files` *string (optional)* Limit the query to return only the Notefile(s) named in this argument (e.g. `&files=track.qo,sensor.qo`). **Basic** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//events-cursor -H 'Authorization: Bearer ' ``` **JS** ```javascript import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure Bearer access token for authorization: personalAccessToken let personalAccessToken = defaultClient.authentications["personalAccessToken"]; personalAccessToken.accessToken = "YOUR ACCESS TOKEN"; let apiInstance = new NotehubJs.EventApi(); let projectOrProductUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String | let opts = { limit: 50, // Number | cursor: "cursor_example", // String | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. sortOrder: "asc", // String | systemFilesOnly: true, // Boolean | files: "_health.qo, data.qo", // String | fleetUID: "fleetUID_example", // String | A Fleet UID. deviceUID: ["null"] // [String] | A Device UID. }; apiInstance.getEventsByCursor(projectOrProductUID, opts).then((data) => { console.log("API called successfully. Returned data: " + JSON.stringify(data)); }, (error) => { console.error(error); }); ``` **Python** ```python import notehub_py from notehub_py.models.get_events_by_cursor200_response import GetEventsByCursor200Response from notehub_py.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.notefile.net configuration = notehub_py.Configuration( host = "https://api.notefile.net" ) # Configure Bearer authorization: personalAccessToken configuration = notehub_py.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.EventApi(api_client) project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | limit = 50 # int | (optional) (default to 50) cursor = "cursor_example" # str | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional) sort_order = "asc" # str | (optional) (default to "asc") system_files_only = True # bool | (optional) files = "_health.qo, data.qo" # str | (optional) fleet_uid = "fleet_uid_example" # str | (optional) device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) try: api_response = api_instance.get_events_by_cursor(project_or_product_uid, limit=limit, cursor=cursor, sort_order=sort_order, system_files_only=system_files_only, files=files, fleet_uid=fleet_uid, device_uid=device_uid) print("The response of EventApi->get_events_by_cursor:\n") pprint(api_response) except Exception as e: print("Exception when calling EventApi->get_events_by_cursor: %s\n" % e) ``` **Optional Params** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//events-cursor?fleetUID=&deviceUID=&limit=&cursor=&sortOrder=&systemFilesOnly=&files=' -H 'Authorization: Bearer ' ``` **Response Members** ### `events` *array* An array of events (see the [Get Project Events](https://dev.blues.io/api-reference/notehub-api/event-api.md#get-project-events) response for a full description of the data elements returned). ### `next_cursor` *string* The cursor value of the next [EventUID](https://dev.blues.io/api-reference/glossary.md#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 ```json { "events": [ { "event": "dfa3747d-688b-4250-935b-5dd60354313c", "session": "b623132c-6afb-4740-bc39-e3634e38f064", "best_id": "My Device", "device": "dev:5c0272311928", "sn": "My Device", "product": "product:com.blues.project:demo", "app": "app:3733f429-9335-6756-3456-c397c0000000", "received": 1656011227.006928, "req": "note.add", "when": 1656010061, "file": "203733583236500300070022#air.qo", "updates": 1, "body": { "humidity": 40.375, "pressure": 97705.66, "temperature": 24.0625, "voltage": 2.598 }, "best_location_type": "triangulated", "best_location_when": 1652709545, "best_lat": 34.82476372, "best_lon": -83.32261614, "best_location": "Atlanta GA", "best_country": "US", "best_timezone": "America/New_York", "tower_when": 1652709545, "tower_lat": 34.82475372, "tower_lon": -83.32261614, "tower_location": "Atlanta GA", "tower_country": "US", "tower_timezone": "America/New_York", "tower_id": "0,0,0,0", "tri_when": 1652709545, "tri_lat": 34.82475372, "tri_lon": -83.32261614, "tri_location": "Atlanta GA", "tri_country": "US", "tri_timezone": "America/New_York", "tri_points": 6 } ], "next_cursor": "00000000-0000-0000-0000-000000000000", "has_more": false } ``` ## Get Fleet Events (Notehub) Get an array of Notehub events by [FleetUID](https://dev.blues.io/api-reference/glossary.md#fleetuid). | | | | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/projects//events/fleets//events` | | Path Parameters: | - `projectOrProductUID` - The [ProjectUID](https://dev.blues.io/api-reference/glossary.md#projectuid) or [ProductUID](https://dev.blues.io/api-reference/glossary.md#productuid) of a Notehub project. - `fleetUID` - The [FleetUID](https://dev.blues.io/api-reference/glossary.md#fleetuid) of a Notehub fleet. | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | > **Note:** > > This API reference displays all possible fields that can be present in an event response. However, certain fields will only be present for certain types of events (e.g. Note added event, Note updated event, .dbs update event, Notehub session event, etc). Arguments ### `fleetUID` *array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of FleetUIDs to filter events by. ### `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). When provided, the `pageNum` must be >= `1`. ### `deviceUID` *array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of [DeviceUIDs](https://dev.blues.io/api-reference/glossary.md#deviceuid) to filter events by. ### `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)* Start date for filtering results, specified as a Unix timestamp ### `endDate` *UNIX Epoch time (optional)* End date for filtering results, specified as a Unix timestamp. ### `dateType` *string (optional)* Which date to filter on, either `captured` or `uploaded`. This will apply to the `startDate` and `endDate` parameters. ### `systemFilesOnly` *boolean (optional)* If `true`, will only return [System Notefiles](https://dev.blues.io/api-reference/system-notefiles.md) in the response. ### `files` *string (optional)* Limit the query to return only the Notefile(s) named in this argument (e.g. `&files=track.qo,sensor.qo`). ### `format` *string (optional)* Response format ("json" or "csv"). ### `serialNumber` *array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of serial numbers to filter events by. ### `sessionUID` *array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of SessionUIDs to filter events by. ### `eventUID` *array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of EventUIDs to filter events by. ### `selectFields` *string (optional)* Comma-separated list of fields to include in the response (e.g., "field1,field2.subfield,field3"). **Basic** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//fleets//events' -H 'Authorization: Bearer ' ``` **JS** ```javascript import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure Bearer access token for authorization: personalAccessToken let personalAccessToken = defaultClient.authentications["personalAccessToken"]; personalAccessToken.accessToken = "YOUR ACCESS TOKEN"; let apiInstance = new NotehubJs.EventApi(); let projectOrProductUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String | let fleetUID = "fleetUID_example"; // String | let opts = { pageSize: 50, // Number | pageNum: 1, // Number | deviceUID: ["null"], // [String] | A Device UID. sortBy: "captured", // String | sortOrder: "asc", // String | startDate: 1628631763, // Number | Unix timestamp endDate: 1657894210, // Number | Unix timestamp dateType: "uploaded", // String | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters systemFilesOnly: true, // Boolean | files: "_health.qo, data.qo", // String | format: "json", // String | Response format (JSON or CSV) serialNumber: ["null"], // [String] | Filter by Serial Number sessionUID: ["null"], // [String] | Filter by Session UID eventUID: ["null"], // [String] | Filter by Event UID selectFields: "selectFields_example", // String | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. }; apiInstance.getFleetEvents(projectOrProductUID, fleetUID, opts).then( (data) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }, (error) => { console.error(error); } ); ``` **Python** ```python import notehub_py from notehub_py.models.get_events200_response import GetEvents200Response from notehub_py.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.notefile.net configuration = notehub_py.Configuration( host = "https://api.notefile.net" ) # Configure Bearer authorization: personalAccessToken configuration = notehub_py.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.EventApi(api_client) project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | fleet_uid = "fleet_uid_example" # str | page_size = 50 # int | (optional) (default to 50) page_num = 1 # int | (optional) (default to 1) device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) sort_by = "captured" # str | (optional) (default to "captured") sort_order = "asc" # str | (optional) (default to "asc") start_date = 1628631763 # int | Unix timestamp (optional) end_date = 1657894210 # int | Unix timestamp (optional) date_type = "captured" # str | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to 'captured') system_files_only = True # bool | (optional) files = "_health.qo, data.qo" # str | (optional) format = "json" # str | Response format (JSON or CSV) (optional) (default to 'json') serial_number = ["serial_number_example"] # List[str] | Filter by Serial Number (optional) session_uid = ["session_uid_example"] # List[str] | Filter by Session UID (optional) event_uid = ["event_uid_example"] # List[str] | Filter by Event UID (optional) select_fields = "select_fields_example" # str | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional) try: api_response = api_instance.get_fleet_events(project_or_product_uid, fleet_uid=fleet_uid, page_size=page_size, page_num=page_num, device_uid=device_uid, sort_by=sort_by, sort_order=sort_order, start_date=start_date, end_date=end_date, date_type=date_type, system_files_only=system_files_only, files=files, format=format, serial_number=serial_number, session_uid=session_uid, event_uid=event_uid, select_fields=select_fields) print("The response of EventApi->get_fleet_events:\n") pprint(api_response) except Exception as e: print("Exception when calling EventApi->get_fleet_events: %s\n" % e) ``` **Optional Params** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//fleets//events?pageSize=&pageNum=&deviceUID=&sortBy=&sortOrder=&startDate=&endDate=&systemFilesOnly=&files=&format=&serialNumber=&sessionUID=&eventUID=&selectFields=' -H 'Authorization: Bearer ' ``` **Response Members** ### `events` *array* An array of events (see the [Get Project Events](https://dev.blues.io/api-reference/notehub-api/event-api.md#get-project-events) response for a full description of the data elements returned). ### `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 ```json { "events": [ { "event": "dfa3747d-688b-4250-935b-5dd60354313c", "session": "b623132c-6afb-4740-bc39-e3634e38f064", "best_id": "My Device", "device": "dev:5c0272311928", "sn": "My Device", "product": "product:com.blues.project.demo", "app": "app:3733f429-9335-6756-3456-c397c0000000", "received": 1656011227.006928, "req": "note.add", "when": 1656010061, "file": "203733583236500300070022#air.qo", "updates": 1, "body": { "humidity": 40.375, "pressure": 97705.66, "temperature": 24.0625, "voltage": 2.598 }, "best_location_type": "triangulated", "best_location_when": 1652709545, "best_lat": 34.82476372, "best_lon": -83.32261614, "best_location": "Atlanta GA", "best_country": "US", "best_timezone": "America/New_York", "tower_id": "0,0,0,0", "tri_when": 1652709545, "tri_lat": 34.82475372, "tri_lon": -83.32261614, "tri_location": "Atlanta GA", "tri_country": "US", "tri_timezone": "America/New_York", "tri_points": 6 } ], "through": "dfa3747d-688b-4250-935b-5dd60354313c", "has_more": false } ``` ## Get Fleet Events by Cursor (Notehub) Get an array of Notehub events by [FleetUID](https://dev.blues.io/api-reference/glossary.md#fleetuid) and cursor (i.e. a means of limiting your result set). | | | | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor` | | Path Parameters: | - `projectOrProductUID` - The [ProjectUID](https://dev.blues.io/api-reference/glossary.md#projectuid) or [ProductUID](https://dev.blues.io/api-reference/glossary.md#productuid) of a Notehub project. - `fleetUID` - The [FleetUID](https://dev.blues.io/api-reference/glossary.md#fleetuid) of a Notehub fleet. | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | > **Note:** > > This API reference displays all possible fields that can be present in an event response. However, certain fields will only be present for certain types of events (e.g. Note added event, Note updated event, .dbs update event, Notehub session event, etc). Arguments ### `limit` *integer (optional)* The number of records to return (minimum value is `1`). Default value is `50`. ### `cursor` *string (optional)* The globally-unique [EventUID](https://dev.blues.io/api-reference/glossary.md#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`. ### `systemFilesOnly` *boolean (optional)* If `true`, will only return [System Notefiles](https://dev.blues.io/api-reference/system-notefiles.md) in the response. ### `files` *string (optional)* Limit the query to return only the Notefile(s) named in this argument (e.g. `&files=track.qo,sensor.qo`). ### `deviceUID` *array (optional)* An [array](https://dev.blues.io/api-reference/notehub-api.md#using-array-arguments) of DeviceUIDs of Notehub [devices](https://dev.blues.io/api-reference/glossary.md#device). ### `startDate` *UNIX Epoch time (optional)* Start date for filtering results, specified as a Unix timestamp ### `endDate` *UNIX Epoch time (optional)* End date for filtering results, specified as a Unix timestamp. **Example** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//fleets//events-cursor?limit=&cursor=&sortOrder=&systemFilesOnly=&files=&deviceUID=&startDate=&endDate=' -H 'Authorization: Bearer ' ``` **JS** ```javascript import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure Bearer access token for authorization: personalAccessToken let personalAccessToken = defaultClient.authentications["personalAccessToken"]; personalAccessToken.accessToken = "YOUR ACCESS TOKEN"; let apiInstance = new NotehubJs.EventApi(); let projectOrProductUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String | let fleetUID = "fleetUID_example"; // String | let opts = { limit: 50, // Number | cursor: "cursor_example", // String | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. sortOrder: "asc", // String | systemFilesOnly: true, // Boolean | files: "_health.qo, data.qo", // String | deviceUID: ["null"], // [String] | A Device UID. startDate: 1628631763, // Number | Unix timestamp endDate: 1657894210 // Number | Unix timestamp }; apiInstance.getFleetEventsByCursor(projectOrProductUID, fleetUID, opts).then( (data) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }, (error) => { console.error(error); } ); ``` **Python** ```python import notehub_py from notehub_py.models.get_events_by_cursor200_response import GetEventsByCursor200Response from notehub_py.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.notefile.net configuration = notehub_py.Configuration( host = "https://api.notefile.net" ) # Configure Bearer authorization: personalAccessToken configuration = notehub_py.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.EventApi(api_client) project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | fleet_uid = "fleet_uid_example" # str | limit = 50 # int | (optional) (default to 50) cursor = "cursor_example" # str | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional) sort_order = "asc" # str | (optional) (default to "asc") system_files_only = True # bool | (optional) files = "_health.qo, data.qo" # str | (optional) device_uid = ["device_uid_example"] # str | A Device UID. (optional) start_date = 1628631763 # int | Unix timestamp (optional) end_date = 1657894210 # int | Unix timestamp (optional) try: api_response = api_instance.get_fleet_events_by_cursor(project_or_product_uid, fleet_uid, limit=limit, cursor=cursor, sort_order=sort_order, system_files_only=system_files_only, files=files, device_uid=device_uid, start_date=start_date, end_date=end_date) print("The response of EventApi->get_fleet_events_by_cursor:\n") pprint(api_response) except Exception as e: print("Exception when calling EventApi->get_fleet_events_by_cursor: %s\n" % e) ``` **Response Members** ### `events` *array* An array of events (see the [Get Project Events](https://dev.blues.io/api-reference/notehub-api/event-api.md#get-project-events) response for a full description of the data elements returned). ### `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 ```json { "events": [ { "event": "dfa3747d-688b-4250-935b-5dd60354313c", "session": "b623132c-6afb-4740-bc39-e3634e38f064", "best_id": "My Device", "device": "dev:5c0272311928", "sn": "My Device", "product": "product:com.blues.project.demo", "app": "app:3733f429-9335-6756-3456-c397c0000000", "received": 1656011227.006928, "req": "note.add", "when": 1656010061, "file": "203733583236500300070022#air.qo", "updates": 1, "body": { "humidity": 40.375, "pressure": 97705.66, "temperature": 24.0625, "voltage": 2.598 }, "best_location_type": "triangulated", "best_location_when": 1652709545, "best_lat": 34.82476372, "best_lon": -83.32261614, "best_location": "Atlanta GA", "best_country": "US", "best_timezone": "America/New_York", "tower_id": "0,0,0,0", "tri_when": 1652709545, "tri_lat": 34.82475372, "tri_lon": -83.32261614, "tri_location": "Atlanta GA", "tri_country": "US", "tri_timezone": "America/New_York", "tri_points": 6 } ], "next_cursor": "00000000-0000-0000-0000-000000000000", "has_more": false } ``` ## Get Route Logs by Event (Notehub) Get an array of route logs associated with a Notehub [project](https://dev.blues.io/api-reference/glossary.md#project) by [event UID](https://dev.blues.io/api-reference/glossary.md#eventuid). | | | | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | HTTP Method: | `GET` | | URL: | `https://api.notefile.net/v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs` | | Path Parameters: | - `projectOrProductUID` - The [ProjectUID](https://dev.blues.io/api-reference/glossary.md#projectuid) or [ProductUID](https://dev.blues.io/api-reference/glossary.md#productuid) of a Notehub project. - `eventUID` - The [EventUID](https://dev.blues.io/api-reference/glossary.md#eventuid) of a Notehub project's event. | | Minimum Notehub [project-level role:](https://dev.blues.io/notehub/notehub-walkthrough.md#collaborator-roles) | viewer | | Required HTTP Headers: | `Authorization: Bearer `, where the token is a valid [authentication token](https://dev.blues.io/api-reference/notehub-api.md#authentication). | Arguments None **Example** **Bash** ```bash curl -X GET -L 'https://api.notefile.net/v1/projects//events//route-logs' -H 'Authorization: Bearer ' ``` **JS** ```javascript import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure Bearer access token for authorization: personalAccessToken let personalAccessToken = defaultClient.authentications["personalAccessToken"]; personalAccessToken.accessToken = "YOUR ACCESS TOKEN"; let apiInstance = new NotehubJs.EventApi(); let projectOrProductUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // String | let eventUID = "4506f411-dea6-44a0-9743-1130f57d7747"; // String | apiInstance.getRouteLogsByEvent(projectOrProductUID, eventUID).then((data) => { console.log("API called successfully. Returned data: " + JSON.stringify(data)); }, (error) => { console.error(error); }); ``` **Python** ```python import notehub_py from notehub_py.models.route_log import RouteLog from notehub_py.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.notefile.net configuration = notehub_py.Configuration( host = "https://api.notefile.net" ) # Configure Bearer authorization: personalAccessToken configuration = notehub_py.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.EventApi(api_client) project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | event_uid = "4506f411-dea6-44a0-9743-1130f57d7747" # str | try: api_response = api_instance.get_route_logs_by_event(project_or_product_uid, event_uid) print("The response of EventApi->get_route_logs_by_event:\n") pprint(api_response) except Exception as e: print("Exception when calling EventApi->get_route_logs_by_event: %s\n" % e) ``` **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* If `true`, an error was returned when routing. ### `status` *string* The status of the event. ### `text` *string* The response body of the route. ### `url` *string* The URL 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", "url": "https://example.com/route" } ] ``` [Device API](https://dev.blues.io/api-reference/notehub-api/device-api.md "Device API") [Jobs API](https://dev.blues.io/api-reference/notehub-api/jobs-api.md "Jobs API")