GET
/
device
/
{device_id}
/
event
Events
curl --request GET \
  --url https://api.pathstack.io/device/{device_id}/event \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "event_key": "ignition_status",
      "time": "2023-11-07T05:31:56Z",
      "raw_data": {},
      "value": {
        "harsh_braking": true
      },
      "position": {
        "latitude": 0,
        "longitude": 0
      },
      "id": "<string>",
      "device_id": "<string>",
      "trip_id": "<string>"
    }
  ],
  "links": {
    "previous": "<string>",
    "current": "<string>",
    "next": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-version
string<date>
default:2024-03-27
Examples:

"2024-03-27"

Path Parameters

​
device_id
string<uuid>
required

Device ID of the Events to be returned

Query Parameters

​
start_time_utc
string<date-time>
required

Start time from when the data will be returned

​
end_time_utc
string<date-time>
required

End time from when the data will be returned

​
event_type
enum<string>

Only include events of this type

Available options:
ignition_status,
idling,
odometer,
harsh_braking,
harsh_acceleration,
hard_cornering,
engine_speed,
accident,
total_fuel,
over_speeding,
power_take_off_engaged,
auxiliary_equipment_operation
​
verify_data_collection
boolean
default:0

Verify data collection status, If true, checks data collection jobs for the time period and fails with a 424 status if any jobs have failed or are still running.

​
page
integer
default:0

Page number for pagination (zero-indexed)

Required range: x >= 0

Response

Successful Response

​
data
Event · object[]
required

Successful response payload

​
links
object
required