Request Methods
The Manifold API supports GET requests for reading data, and a small set of POST, PUT and DELETE requests to manage your webhooks. Everything else is read-only.
Every request needs your x-api-key header. Most endpoints also need the Connection-Id header, which names the connection whose data you want. A missing Connection-Id, or one that is not yours, answers 400.
1. Connections
GET /connections: the connections of your account.- Headers:
x-api-key. NoConnection-Id.
2. Drivers
GET /drivers: the drivers of a connection (not paginated).GET /drivers/{driverId}: one driver.- Headers:
x-api-key,Connection-Id.
3. Safety Events
GET /safety-events: the events of a connection betweenfromandto(at most 30 days, the wholetoday included). Filters:vehicleIds,driverIds,eventType,minIntensity,minRiskScore. Paginated withlimitandcursor.GET /safety-events/counts: the events counted by risk band.GET /safety-events/types: the event types.GET /safety-events/{id}/thumbnails/{camPos},/videos/{camPos},/images/{camPos}: the media of an event.camPosisin,exorreex.- Headers:
x-api-key,Connection-Id.
4. Accidents
GET /accidents: the accidents and minor collisions of a connection betweenfromandto(at most 120 days). Paginated withlimitandcursor.GET /accidents/{id},/accidents/{id}/reconstruction-map,/accidents/{id}/report.pdf.- Headers:
x-api-key,Connection-Id.
5. Trips
GET /trips: the trips of a connection betweenfromandto. Paginated withlimitandcursor.GET /trips/{id}: one trip, with its GPS points.- Headers:
x-api-key,Connection-Id.
6. Vehicles
GET /vehicles: the vehicles of a connection (not paginated).GET /vehicles/{vehicleId}: one vehicle.GET /vehicles/{vehicleId}/distance-driven: the distance driven betweenfromandto.GET /vehicles/{vehicleId}/score: the vehicle's risk score betweenfromandto.GET /vehicles/pricing?vin=: the price estimate of a vehicle by VIN. NoConnection-Id; limited per day.- Headers:
x-api-key,Connection-Id(not for pricing).
7. Coaching
GET /coachings/messages: the coaching messages betweenfromandto. Paginated withlimit(at most 100) andcursor.- Headers:
x-api-key,Connection-Id.
8. Webhooks
GET /webhooks,POST /webhook,PUT /webhook/{id},DELETE /webhook/{id}.- Headers:
x-api-key. NoConnection-Id.
9. Reports
GET /reports/event-accuracy,/reports/global,/reports/overview/usage,/reports/overview/behavioral,/reports/overview/environmental.GET /reports/event-statistics,/reports/manifold-event-count,/reports/event-risk-count: the Validation Engine reports (your account needs the Validation Engine feature).GET /reports/incident-counts, and/vehicles/{vehicleId}/incident-counts,/drivers/{driverId}/incident-counts: the incident counts (your account needs the Analytics feature).GET /reports/safety-scores/summary,/reports/safety-scores/vehicles,/reports/safety-scores/export,/reports/safety-scores/drivers,/reports/safety-scores/drivers/export: the vehicle and driver safety scores of the portal's Safety Scores page (your account needs the Analytics feature).range(week,monthorquarter) is required.vehiclesanddriversare paginated withpageandpageSize.- Headers:
x-api-key. The reports take an optionalconnectionIdquery parameter instead of theConnection-Idheader. - Date ranges: event accuracy, usage, behavioral and environmental reports at most 30 days; Validation Engine reports at most 120 days; incident counts take
period30, 60 or 90.
Updated 1 day ago
Did this page help you?