Event API

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

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.EventApi();
let projectUID = "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.
  deviceUIDs: ["null"], // [String] | Deprecated.
  since: "since_example" // String | Deprecated.
};
apiInstance.getProjectEvents(projectUID, opts).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);

import notehub_py
from notehub_py.models.get_project_events200_response import GetProjectEvents200Response
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 API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# 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_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)
    device_uids = ["device_uids_example"] # List[str] | Deprecated. (optional)
    since = "since_example" # str | Deprecated. (optional)

    try:
        api_response = api_instance.get_project_events(project_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, device_uids=device_uids, since=since)
        print("The response of EventApi->get_project_events:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventApi->get_project_events: %s\n" % e)

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/events?pageSize=<pageSize>&pageNum=<pageNum>&deviceUID=<deviceUID>&sortBy=<sortBy>&sortOrder=<sortOrder>&startDate=<startDate>&endDate=<endDate>&dateType=<dateType>&systemFilesOnly=<systemFilesOnly>&files=<files>&format=<format>&serialNumber=<serialNumber>&fleetUID=<fleetUID>&sessionUID=<sessionUID>&eventUID=<eventUID>&selectFields=<selectFields>'
    -H 'Authorization: Bearer <access_token>'

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/events?files=track.qo,sensor.qo'
    -H 'Authorization: Bearer <access_token>'

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

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.EventApi();
let projectUID = "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.getProjectEventsByCursor(projectUID, opts).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);

import notehub_py
from notehub_py.models.get_project_events_by_cursor200_response import GetProjectEventsByCursor200Response
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 API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# 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_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_project_events_by_cursor(project_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_project_events_by_cursor:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventApi->get_project_events_by_cursor: %s\n" % e)

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/events-cursor?fleetUID=<fleetUID>&deviceUID=<deviceUID>&limit=<limit>&cursor=<cursor>&sortOrder=<sortOrder>&systemFilesOnly=<systemFilesOnly>&files=<files>'
    -H 'Authorization: Bearer <access_token>'

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

import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.EventApi();
let projectUID = "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.
  deviceUIDs: ["null"], // [String] | Deprecated.
  since: "since_example" // String | Deprecated.
};
apiInstance.getFleetEvents(projectUID, fleetUID, opts).then(
  (data) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  (error) => {
    console.error(error);
  }
);

import notehub_py
from notehub_py.models.get_project_events200_response import GetProjectEvents200Response
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 API key authorization: api_key
configuration.api_key["api_key"] = os.environ["API_KEY"]

# 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_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)
    device_uids = ["device_uids_example"] # List[str] | Deprecated. (optional)
    since = "since_example" # str | Deprecated. (optional)

    try:
        api_response = api_instance.get_fleet_events(project_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, device_uids=device_uids, since=since)
        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)

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/fleets/<fleetUID>/events?pageSize=<pageSize>&pageNum=<pageNum>&deviceUID=<deviceUID>&sortBy=<sortBy>&sortOrder=<sortOrder>&startDate=<startDate>&endDate=<endDate>&systemFilesOnly=<systemFilesOnly>&files=<files>&format=<format>&serialNumber=<serialNumber>&sessionUID=<sessionUID>&eventUID=<eventUID>&selectFields=<selectFields>'
    -H 'Authorization: Bearer <access_token>'