Sign in
event

Get Events of a Fleet

get/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events

Path parameters

projectOrProductUIDstring required
fleetUIDstring required

Query parameters

pageSizeinteger
pageNuminteger
deviceUIDstring[]

A Device UID.

sensorUIDstring[]

A sensor UID to filter events by, matched exactly against the event sensor field. The value may carry any prefix.

sortBy'best_id' | 'device_serial' | 'device_uid' | 'captured' | 'modified' | 'device_location' | 'tower_location' | 'triangulated_location' | 'best_location'
sortOrder'asc' | 'desc'
startDateinteger

Start date for filtering results, specified as a Unix timestamp

endDateinteger

End date for filtering results, specified as a Unix timestamp

dateType'captured' | 'uploaded'

Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters

systemFilesOnlyboolean
filesstring
format'json' | 'csv'

Response format (JSON or CSV)

serialNumberstring[]

Filter by Serial Number

sessionUIDstring[]

Filter by Session UID

eventUIDstring[]

Filter by Event UID

selectFieldsstring

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.

deviceUIDsstring[]

Deprecated.

sincestring

Deprecated.

Response

The response body from a GET events request.

has_moreboolean required

True if there are more events

throughstring

The UID of the last event returned

Example response

{
  "events": [
    {
      "bars": 2,
      "best_location_when": 1652709545,
      "moved": 7,
      "rsrp": -91,
      "rsrq": -13,
      "rssi": -72,
      "sinr": 18,
      "tower_when": 1669667691,
      "tri_points": 6,
      "tri_when": 1652709545,
      "updates": 1,
      "when": 1656010061,
      "when_ms": 1656010061123,
      "where_when": 1652709545
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.