Request Methods

The Manifold API exclusively supports GET requests for read-only data retrieval. Below are the details of the endpoints and their functionality based on the updated API:

1. Connections

Endpoint: /connections
Method: GET
Description: Retrieve a list of all connections within your account. Connections represent the integration between your telematics provider and Manifold.
Required Headers:
- x-api-key: API Key for authentication.
- Connection-Id: Optional if filtering by specific connections.

2. Drivers

Endpoints:
- /drivers:
  - Method: GET
  - Description: List all drivers in your connected account.
  - Required Headers:
    - x-api-key: API Key for authentication.
    - Connection-Id: Optional for filtering drivers by a connection.
  - Query Parameters:
    - Pagination supported with limit and cursor.
- /drivers/{driverId}:
  - Method: GET
  - Description: Retrieve details of a specific driver using their unique driverId.
  - Required Headers:
    - x-api-key: API Key for authentication.

3. Safety Events

Endpoints:
- /safety-events:
  - Method: GET
  - Description: Retrieve all safety events recorded by the system, such as harsh braking or collisions.
  - Required Headers:
    - x-api-key: API Key for authentication.
    - Connection-Id: Required to specify the connection to retrieve safety event data.
  - Query Parameters:
    - from, to (date range).
    - Filters: vehicleIds, driverIds.
- /safety-events/types:
  - Method: GET
  - Description: Retrieve a list of supported safety event types (e.g., "Harsh Braking", "Crash").
- /safety-events/{id}/thumbnails/{camPos}:
  - Method: GET
  - Description: Retrieve the thumbnail image for a specific safety event.
  - Path Parameters:
    - id: Safety Event ID.
    - camPos: Camera position (e.g., "front", "rear").
- /safety-events/{id}/videos/{camPos}:
  - Method: GET
  - Description: Retrieve video footage for a specific safety event.
  - Path Parameters:
    - id: Safety Event ID.
    - camPos: Camera position.

4. Trips

Endpoints:
- /trips:
  - Method: GET
  - Description: List all trips in your account.
  - Required Headers:
    - x-api-key: API Key for authentication.
- /trips/{tripId}:
  - Method: GET
  - Description: Retrieve detailed information about a specific trip using its tripId.
- /trips/locations:
  - Method: GET
  - Description: Retrieve breadcrumb GPS locations for historical trips within a specific time range.
  - Query Parameters:
    - from, to (date range).

5. Vehicles

Endpoints:
- /vehicles:
  - Method: GET
  - Description: List all vehicles in your account.
  - Required Headers:
    - x-api-key: API Key for authentication.
- /vehicles/{vehicleId}:
  - Method: GET
  - Description: Retrieve detailed information for a specific vehicle.
  - Path Parameters:
    - vehicleId: Vehicle ID.
- /vehicles/{vehicleId}/distance-driven:
  - Method: GET
  - Description: Retrieve the historical distance data for a specific vehicle within a specified time range.
  - Query Parameters:
    - from, to (date range).

6. Reports

Endpoint: /reports
Method: GET
Description: Retrieve event accuracy statistics (e.g., accurate, inaccurate, or unjustified events) for a specified time range.
Required Headers:
- x-api-key: API Key for authentication.
- Connection-Id: Required to specify the connection for the report.
Query Parameters:
- from, to (date range).