Endpoints Overview

An endpoint is a specific address that returns one kind of data. All endpoints use GET, need your x-api-key, and answer with the same envelope: { "status", "message", "data", "next" } (the three overview reports under Reports answer with the report itself).

Most endpoints also need the Connection-Id header: the id of one of your connections, which you get from GET /connections. Endpoints that work across your whole account, or that take a connectionId query parameter instead, are marked below.

The API Reference lists every parameter and field of every endpoint.

1. Connections

GET /connections

Your connections, with their provider and health status. This is where you find the Connection-Id for the other endpoints. No Connection-Id header needed. See Connections.

2. Drivers

GET /drivers, GET /drivers/{driverId}

The drivers of a connection: name, contact details, licence and status. See Drivers.

3. Vehicles

GET /vehicles, GET /vehicles/{vehicleId}, GET /vehicles/{vehicleId}/distance-driven, GET /vehicles/{vehicleId}/score, GET /vehicles/pricing

The vehicles of a connection with their VIN, status, last known position and details; the distance a vehicle drove between two dates; its risk score; and the price estimate of a vehicle by VIN. GET /vehicles/pricing does not use a Connection-Id and has a daily limit. See Vehicles.

4. Safety Events

GET /safety-events, GET /safety-events/counts, GET /safety-events/types, and the thumbnail, video and image of an event

The incidents recorded on your vehicles, such as harsh braking, speeding or near collisions, with their risk rating and camera media. See Safety Events.

5. Accidents

GET /accidents, GET /accidents/{id}, GET /accidents/{id}/reconstruction-map, GET /accidents/{id}/report.pdf

The accidents and minor collisions of a connection, with the sections of the portal's accident report, the reconstruction map, and the report as a PDF. See Accidents.

6. Trips

GET /trips, GET /trips/{id}

The trips of a connection: the vehicle and driver, start and end time and place, distance, duration, maximum speed and the GPS points of the trip (gpsData). GET /trips is paginated with cursor and limit.

7. Coaching

GET /coachings/messages

The coaching messages Manifold sent to drivers, between from and to, paginated with cursor and limit (at most 100).

8. Webhooks

GET /webhooks, POST /webhook, PUT /webhook/{id}, DELETE /webhook/{id}

Webhooks that send you event and accident notifications as they happen. These endpoints work on your account and do not use a Connection-Id. See Webhooks.

9. Reports

  • GET /reports/event-accuracy: how accurate the provider's events were
  • GET /reports/global: anonymized industry benchmarks across all clients: the normalized average of accurate incidents per incident type
  • GET /reports/overview/usage, /behavioral and /environmental: the overview reports of the portal, as the report itself, without the envelope
  • GET /reports/event-statistics, /manifold-event-count and /event-risk-count: the Validation Engine reports. See Validation Engine Reports

Reports take a connectionId query parameter (optional) instead of a header.

10. Incident Counts

GET /vehicles/{vehicleId}/incident-counts, GET /drivers/{driverId}/incident-counts, GET /reports/incident-counts

The incidents per type over the last 30, 60 or 90 days, with how many are confirmed accurate and the change from the period before. See Incident Counts.

11. Safety Scores

GET /reports/safety-scores/summary, GET /reports/safety-scores/vehicles, GET /reports/safety-scores/export, GET /reports/safety-scores/drivers, GET /reports/safety-scores/drivers/export

The figures of the portal's Safety Scores page, per vehicle and per driver, for the latest completed week, month or quarter: score, change from the period before, distance, incidents (vehicles only), quartile and rank in connection, and the score distribution the portal draws its chart from. They take a connectionId query parameter (optional) instead of a header, and need the Analytics feature. See Safety Scores.


Did this page help you?